edu.columbia.surge.hashImpl
Class PersonalPronounH

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

public class PersonalPronounH
extends FDH
implements PersonalPronoun

The personal-pronoun category. In general, a personal-pronoun is used as participants of processes. For a personal-pronoun, at the very least, user has to specify whether it is first, second or third person and also whether it is plural. User can also set the gender of the pronoun. The person and the gender of the pronoun can be set using the static constants provided in this class. For example, if user wants to set it to be first person, he/she can use setPerson(PersonalPronoun.FIRST) to achieve the task. There are methods to set the person, the plurality and the gender of the personal-pronoun. A factory method is also provided to serve the functionality of a constructor which user feeds in all the properties of the desired pronoun as parameters to the method. User can either use the PersonalPronounFactoryH class or directly use the constructor of this class to create instances of PersonalPronounH.

See Also:
Partic, PersonalPronounFactoryH, Serialized Form

Constructor Summary
PersonalPronounH()
          Constructor.
PersonalPronounH(java.lang.String person)
          Constructor which computes and returns an instance of PersonalPronounH with the given specification of the whether the FD is in first, second or third person since specifying the person is the least requirement in creating a PersonPronoun.
PersonalPronounH(java.lang.String person, boolean plurality, java.lang.String gender)
          A factory method which computes and returns an instance of PersonalPronounH.
 
Method Summary
 void setGender(java.lang.String gender)
          A method to set the gender of the personal-pronoun.
 void setPerson(java.lang.String person)
          A method to set the person of the personal-pronoun.
 void setPlural(boolean plural)
          A method to set whether the personal-pronoun is plural.
 
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

PersonalPronounH

public PersonalPronounH()
Constructor. It creates a default instance of PersonalPronounH.

PersonalPronounH

public PersonalPronounH(java.lang.String person)
                 throws InvalidConstructorException
Constructor which computes and returns an instance of PersonalPronounH with the given specification of the whether the FD is in first, second or third person since specifying the person is the least requirement in creating a PersonPronoun.
Parameters:
person - specify whether the personal-pronoun should be first, second or third person. Can use the static constants as parameters, example: PersonalPronoun.SECOND

PersonalPronounH

public PersonalPronounH(java.lang.String person,
                        boolean plurality,
                        java.lang.String gender)
                 throws InvalidConstructorException
A factory method which computes and returns an instance of PersonalPronounH. Only person is strictly required to enter as parameter because it is the minimum requirement to construct a PersonPronoun object, the rest of the parameters are optional.
Parameters:
person - specify whether the personal-pronoun should be first, second or third person. Can use the static constants as parameters, example: PersonalPronoun.SECOND
plurality - specify whether the personal-pronoun should be plural or singular.
gender - specify the gender of the personal-pronoun, can use the static constants in this class (example: PersonalPronoun.NEUTRAL) to feed in as parameters
Method Detail

setPerson

public void setPerson(java.lang.String person)
A method to set the person of the personal-pronoun.
Specified by:
setPerson in interface PersonalPronoun
Parameters:
person - set whether the personal-pronoun to be first, second or third person. User can use the static constants in this class as parameters.

setPlural

public void setPlural(boolean plural)
A method to set whether the personal-pronoun is plural. User can use the constants in the FDProperties to set the pluraity.
Specified by:
setPlural in interface PersonalPronoun
Parameters:
pluraity - true to be plural and false to be singular
See Also:
FDProperties

setGender

public void setGender(java.lang.String gender)
A method to set the gender of the personal-pronoun.
Specified by:
setGender in interface PersonalPronoun
Parameters:
gender - can use the static variables in this class as paratmers