edu.columbia.surge
Interface Clause

All Known Implementing Classes:

ClauseH

public abstract interface Clause

extends FD

The clause category for a FD. This class is used whenever users want to create a clause. As the minimum requirement, this class must be used together with the Partic and Proc class. In addition to setting the process and the participant of a clause, there are methods in this class to set the various properties of a clause. For methods that set the properties of a clause such as the setTense(...) and setPolarity(...) methods, some of the possible values/options for these methods are provided in the FDProperties class.

See Also:

ClauseFactory, Proc, Partic, FDProperties

Inner classes inherited from class java.util.Map

java.util.Map.Entry

Method Summary

void	setAdverb(java.lang.String adverb) A method to set the adverb of a clause.
void	setCircum(Circum circum) A method to set the circumstance of a clause.
void	setComplex(java.lang.String complex) A method to set the complexity of a clause.
void	setMood(java.lang.String mood) A method to set the mood of a clause.
void	setPartic(Partic partic) A method to set the participants of a clause.
void	setPolarity(java.lang.String polarity) A method to set the polarity of a clause.
void	setPreMod(PreMod preMod) A method to set the pre-modifier of a clause.
void	setProc(Proc process) A method to set the process of a clause.
void	setRestrictive(boolean restrictiveness) A method to set the restrictiveness of a clause.
void	setScope(java.lang.String[] scope) A method to set the scope of a clause by specifying the path of the holes in an array.
void	setScopeUsingRef(FDRef ref) A method to set the scope of a clause by making a referrence to the desired hole of the clause.
void	setTense(java.lang.String tense) A method to allow the user to set the tense of the clause.

Methods inherited from interface edu.columbia.surge.FD

checkPath, checkPath, getPath, getPath, putPath, putPath, putPathOverride, putPathOverride, toString, toXML

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

setProc

public void setProc(Proc process)

A method to set the process of a clause. (Required for a clause)

Parameters:

proc - the process to be specified

setPartic

public void setPartic(Partic partic)

A method to set the participants of a clause. (Required)

Parameters:

partic - the participants to be specified

setTense

public void setTense(java.lang.String tense)

A method to allow the user to set the tense of the clause. (Optional)

Parameters:

tense - the tense of the clause

setAdverb

public void setAdverb(java.lang.String adverb)
               throws InvalidPathException

A method to set the adverb of a clause. (Optional)

Parameters:

adverb - the adverb to be inserted

setRestrictive

public void setRestrictive(boolean restrictiveness)

A method to set the restrictiveness of a clause. (Optional)

Parameters:

restrictiveness - true to be restrictive, false to be non-restrictive

setPolarity

public void setPolarity(java.lang.String polarity)

A method to set the polarity of a clause. By default, the polarity is positive. (Optional)

Parameters:

polarity - the polarity of a clause

setMood

public void setMood(java.lang.String mood)

A method to set the mood of a clause. (Optional)

Parameters:

mood - the mood of the clause

setScope

public void setScope(java.lang.String[] scope)

A method to set the scope of a clause by specifying the path of the holes in an array. (Optional)

Parameters:

scope - specify the order of the roles by putting them in the right order into the array. For example, (scope {^ A B}) will be {"A", "B"}.

setScopeUsingRef

public void setScopeUsingRef(FDRef ref)

A method to set the scope of a clause by making a referrence to the desired hole of the clause. If the hole is empty without any properties, it will be a FDNull object. Otherwise, the hole will just be a normal FD but it will be referrenced to the clause as the hole.

Parameters:

ref - the FD node which serves as the hole of the clause.

See Also:

FDNull

setComplex

public void setComplex(java.lang.String complex)

A method to set the complexity of a clause. (Optional)

Parameters:

complex - the complexity to be specified

setCircum

public void setCircum(Circum circum)

A method to set the circumstance of a clause. (Optional)

Parameters:

circum - the circumstance to be specified

setPreMod

public void setPreMod(PreMod preMod)

A method to set the pre-modifier of a clause. (Optional)

Parameters:

preMod - the pre-modifier to be specified