edu.columbia.surge.hashImpl
Class CircumH

java.lang.Object
  |
  +--java.util.AbstractMap
        |
        +--java.util.HashMap
              |
              +--edu.columbia.surge.hashImpl.FDH
                    |
                    +--edu.columbia.surge.hashImpl.CircumH

public class CircumH

extends FDH

implements Circum

The circumstance category. This is often used together with the Clause, Proc and Partic classes because the parimary usage of a circumstance is to describe the settings of the process of a clause. This class has methods to set the lexical entry which tells the circumstance and also has methods to set the characteristics of the circumstance. This is the class that implements the Circum interface and is implemented in the form of a HashMap as it is inherrited from the FDH class. This class consists of methods and constructors to set the required components of a CircumH. User can either use the CircumFactoryH class or directly use the constructor of this class to create instances of CircumH. purpose.

See Also:

Clause, Proc, Partic, PreMod, CircumFactoryH, Serialized Form

Constructor Summary

CircumH()
Default Constructor which creates a default instance of CircumH object without any parameters.

CircumH(FD behalf, FD effect, FD inLoc, FD manner, FD purpose, FD reason, FD time, java.lang.String lex)
The factory method which creates an instance of CircumH object with the given entries that tell and specify the circumstance.

CircumH(java.lang.String propertyName, FD propertyBody, java.lang.String lex)
Constructor which creates an instance of CircumH object with the given entries that tell and specify the circumstance.

Method Summary

void	setBehalf(FD behalf) A method to set the behalf of the circumstance.
void	setEffect(FD effect) A method to set the effect of the circumstance.
void	setInLoc(FD in_loc) A method to set the in-loc of the circumstance.
void	setLex(java.lang.String lex) A method to set the lexical entry of the circumstance.
void	setManner(FD manner) A method to set the manner of the circumstance.
void	setPurpose(FD purpose) A method to set the purpose of the circumstance.
void	setReason(FD reason) A method to set the reason of the circumstance.
void	setTime(FD time) A method to set the time of the circumstance.

Methods inherited from class edu.columbia.surge.hashImpl.FDH

checkPath, checkPath, computePathDifference, getPath, getPath, putPath, putPath, putPathOverride, putPathOverride, stackToPath, stringToArray, toString, toString, toXML

Methods inherited from class java.util.HashMap

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

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CircumH

public CircumH()

Default Constructor which creates a default instance of CircumH object without any parameters.

CircumH

public CircumH(java.lang.String propertyName,
               FD propertyBody,
               java.lang.String lex)
        throws InvalidConstructorException

Constructor which creates an instance of CircumH object with the given entries that tell and specify the circumstance. If invalid parameters are input, an exception will be thrown.

Parameters:

propertyName - the name of the circumstance property

propertyBody - the body of the circumstance property

lex - the possible lexical entry of the circumstance

Throws:

InvalidConstructorException -

CircumH

public CircumH(FD behalf,
               FD effect,
               FD inLoc,
               FD manner,
               FD purpose,
               FD reason,
               FD time,
               java.lang.String lex)
        throws InvalidConstructorException

The factory method which creates an instance of CircumH object with the given entries that tell and specify the circumstance. This constructor accounts for all possible cirsumtances that users can specify. Among all the possible input circumstance characteristics, users should only enter one characteristic and set the rest of them be null. Otherwise, if more than one characteristics is inputted, an exception should be thrown. If invalid parameters are input, an exception will be thrown.

Parameters:

behalf - the behalf characteristics of the circumstance

effect - the effect characteristics of the circumstance

inLoc - the in-location characteristics of the circumstance

manner - the manner characteristics of the circumstance

purpose - the purpose characteristics of the circumstance

reason - the reason characteristics of the circumstance

time - the time characteristics of the circumstance

lex - the possible lexical entry of the circumstance

Throws:

InvalidConstructorException -

Method Detail

setLex

public void setLex(java.lang.String lex)

A method to set the lexical entry of the circumstance.

Specified by:

setLex in interface Circum

Parameters:

lex -

setBehalf

public void setBehalf(FD behalf)

A method to set the behalf of the circumstance.

Specified by:

setBehalf in interface Circum

Parameters:

behalf -

setEffect

public void setEffect(FD effect)

A method to set the effect of the circumstance.

Specified by:

setEffect in interface Circum

Parameters:

effect -

setInLoc

public void setInLoc(FD in_loc)

A method to set the in-loc of the circumstance.

Specified by:

setInLoc in interface Circum

Parameters:

in_loc -

setManner

public void setManner(FD manner)

A method to set the manner of the circumstance.

Specified by:

setManner in interface Circum

Parameters:

manner -

setPurpose

public void setPurpose(FD purpose)

A method to set the purpose of the circumstance.

Specified by:

setPurpose in interface Circum

Parameters:

purpose -

setReason

public void setReason(FD reason)

A method to set the reason of the circumstance.

Specified by:

setReason in interface Circum

Parameters:

reason -

setTime

public void setTime(FD time)

A method to set the time of the circumstance.

Specified by:

setTime in interface Circum

Parameters:

time -