edu.columbia.surge.hashImpl
Class ParticH

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

public class ParticH

extends FDH

implements Partic

The participant of a FD in a clause. This is used when user creates a clause and thus is used together with the Proc and Clause class. Depends on what the process is, users will only need to use the ones that they need for that particular process. However, here i try to provide all kinds of information for users to composite various kinds of participant. There are methods to set the subject and object of the participant independently, and there are also methods to set up particular subject/object pairs since for the most cases, there usually has a pair of elements in a participant of a clause. By using the "pair-methods" to setup participant also help users to reduce the risk of grouping incompatible subject/object pair. In the "pair-methods", i try to summarize in what scenarios will user need to use that particular method. However, the information that i gave there is not complete. User should always follow the spec of SURGE since there may be other different combinations. Moreover, in some cases, there will be two pair of participants in each scenario. In those cases, users can create a pair using the constructor and create another pair using one of the set methods in this class. This class is implemented in the form of a HashMap which the values within a Participant are hashed into the HashMaps. User can either use the ParticFactoryH class or directly use the constructor of this class to create instances of ParticH.

See Also:

ParticFactoryH, Clause, Proc, Serialized Form

Constructor Summary

ParticH()
Constructor.

ParticH(java.lang.String particName, FD particBody)
Constructor.

ParticH(java.lang.String subjectName, FD subjectBody, java.lang.String objectName, FD objectBody)
A factory method which creates an instance of ParticH with the given names and the bodies of the participant.

Method Summary

void	setAccompaniment(FD accompaniment) A method to set the accompaniment
void	setAddressee(FD addressee) A method to set the addressee of the participant
void	setAffected(FD affected) A method to set the affected of the participant
void	setAgent(FD agent) A method to set the agent of the participant
void	setAgentAffectedPair(FD agent, FD affected) A method to set the agent-affected pair; this is used when we have the dispositive effect-type.
void	setAgentCreatedPair(FD agent, FD created) A method to set the agent-created pair; this is used when we have the creative effect-type.
void	setAgentLocationPair(FD agent, FD location) A method to set the agent-location pair; this method is used.
void	setAgentRangePair(FD agent, FD range) A method to set the agent-range pair; this method is used when we have the effect-type of with-range.
void	setAttribute(FD attribute) A method to set the attribute of the participant
void	setCarrier(FD carrier) A method to set the carrier of the participant
void	setCarrierAttributePair(FD carrier, FD attribute) A method to set the carrier-attribute pair; this is used when we have the ascriptive process type and attributive effect-type.
void	setCreated(FD created) A method to set the created of the participant
void	setIdentified(FD identified) A method to set the identified of the participant
void	setIdentifiedIdentifierPair(FD identified, FD identifier) A method to set the identified-identifier pair; this is used when we have the ascriptive process type and the equative effect-type.
void	setIdentifier(FD identifier) A method to set the identifier of the partic
void	setLocated(FD located) A method to set the located of the partic
void	setLocatedAccompanimentPair(FD located, FD accompaniment) A method to set the located-accompaniment pair; this is used when you have the locative and accompaniment type.
void	setLocatedLocationPair(FD located, FD location) A method to set the located-location pair; this is used when you have a spatial and attributive type.
void	setLocatedTimePair(FD located, FD time) A method to set the located-time pair; this is used when you have a locative and temporal type.
void	setLocation(FD location) A method to set the location
void	setPhenomenon(FD phenom) A method to set the phenomenon of the participant
void	setPossessed(FD possessed) A method to set the possessed of the partic
void	setPossessor(FD possessor) A method to set the possessor of the partic
void	setPossessorPossessedPair(FD possessor, FD possessed) A method to set the possessor-possessed pair; this is used when we have the possessive process type and attributive effect-type.
void	setProcessor(FD processor) A method to set the processor of the participant
void	setProcessorPhenomenonPair(FD processor, FD phenom) A method to set the processor-phenomenon pair; this is used when we have the mental process type.
void	setRange(FD range) A method to set the range of the participant
void	setSayer(FD sayer) A method to set the sayer of the participant
void	setSayerAddresseePair(FD sayer, FD addressee) A method to set the sayer-addressee pair; this is used when we have the verbal process type.
void	setSayerVerbalizationPair(FD sayer, FD verbalization) A method to set the sayer-verbalization pair; this is used when we have the verbal process type.
void	setTime(FD time) A method to set the time
void	setVerbalization(FD verbalization) A method to set the verbalization of the participant

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

ParticH

public ParticH()

Constructor. It creates a default instance of ParticH.

ParticH

public ParticH(java.lang.String particName,
               FD particBody)
        throws InvalidConstructorException

Constructor. It creates an instance of ParticH with the given name and the body of the participant. Both parameters in the constructors have to be present. This is used for clauses that only have one participant. If invalid name and body are entered, an exception will be thrown.

Parameters:

particName - the name of the type of participant

particbody - the specification of the participant

Throws:

InvalidConstructorException -

ParticH

public ParticH(java.lang.String subjectName,
               FD subjectBody,
               java.lang.String objectName,
               FD objectBody)
        throws InvalidConstructorException

A factory method which creates an instance of ParticH with the given names and the bodies of the participant. There are a lot of instances participants come in the form of pairs. This factory method allows users to create participant pairs in one line of code. All four parameters of the constructor have to be present. For clauses that have both participants, if invalid names and body entries are entered, an exception will be thrown.

Parameters:

subjectName - the name of the type of the first participant

subjectBody - the body specification of the first participant

objectName - the name of the type of the other participant

objectBody - the body specification of the other participant

Throws:

InvalidConstructorException -

Method Detail

setAgent

public void setAgent(FD agent)

A method to set the agent of the participant

Specified by:

setAgent in interface Partic

Parameters:

agent - the agent of the participant

setRange

public void setRange(FD range)

A method to set the range of the participant

Specified by:

setRange in interface Partic

Parameters:

range - the range of the participant

setCreated

public void setCreated(FD created)

A method to set the created of the participant

Specified by:

setCreated in interface Partic

Parameters:

created - the created of the participant

setAffected

public void setAffected(FD affected)

A method to set the affected of the participant

Specified by:

setAffected in interface Partic

Parameters:

affected - the affected of the participant

setProcessor

public void setProcessor(FD processor)

A method to set the processor of the participant

Specified by:

setProcessor in interface Partic

Parameters:

processor - the processor of the participant

setPhenomenon

public void setPhenomenon(FD phenom)

A method to set the phenomenon of the participant

Specified by:

setPhenomenon in interface Partic

Parameters:

phenomenon - the phenomenon of the participant

setSayer

public void setSayer(FD sayer)

A method to set the sayer of the participant

Specified by:

setSayer in interface Partic

Parameters:

sayer - the sayer of the participant

setAddressee

public void setAddressee(FD addressee)

A method to set the addressee of the participant

Specified by:

setAddressee in interface Partic

Parameters:

addressee - the addressee of the participant

setVerbalization

public void setVerbalization(FD verbalization)

A method to set the verbalization of the participant

Specified by:

setVerbalization in interface Partic

Parameters:

verbalization - the verbalization of the participant

setCarrier

public void setCarrier(FD carrier)

A method to set the carrier of the participant

Specified by:

setCarrier in interface Partic

Parameters:

carrier - the carrier of the participant

setAttribute

public void setAttribute(FD attribute)

A method to set the attribute of the participant

Specified by:

setAttribute in interface Partic

Parameters:

attribute - the attribute of the participant

setIdentified

public void setIdentified(FD identified)

A method to set the identified of the participant

Specified by:

setIdentified in interface Partic

Parameters:

identified - the identified of the participant

setIdentifier

public void setIdentifier(FD identifier)

A method to set the identifier of the partic

Specified by:

setIdentifier in interface Partic

Parameters:

identifier - the identifier of the partic

setPossessor

public void setPossessor(FD possessor)

A method to set the possessor of the partic

Specified by:

setPossessor in interface Partic

Parameters:

possessor - the possessor of the partic

setPossessed

public void setPossessed(FD possessed)

A method to set the possessed of the partic

Specified by:

setPossessed in interface Partic

Parameters:

possessed - the possessed of the partic

setLocated

public void setLocated(FD located)

A method to set the located of the partic

Specified by:

setLocated in interface Partic

Parameters:

located - the located of the partic

setAccompaniment

public void setAccompaniment(FD accompaniment)

A method to set the accompaniment

Specified by:

setAccompaniment in interface Partic

Parameters:

accompaniment - the accompaniment

setTime

public void setTime(FD time)

A method to set the time

Specified by:

setTime in interface Partic

Parameters:

time - the time

setLocation

public void setLocation(FD location)

A method to set the location

Specified by:

setLocation in interface Partic

Parameters:

location - the location

setAgentRangePair

public void setAgentRangePair(FD agent,
                              FD range)

A method to set the agent-range pair; this method is used when we have the effect-type of with-range.

Specified by:

setAgentRangePair in interface Partic

Parameters:

agent - the agent

range - the range

setAgentLocationPair

public void setAgentLocationPair(FD agent,
                                 FD location)

A method to set the agent-location pair; this method is used.

Specified by:

setAgentLocationPair in interface Partic

Parameters:

agent - the agent

location - the location

setAgentCreatedPair

public void setAgentCreatedPair(FD agent,
                                FD created)

A method to set the agent-created pair; this is used when we have the creative effect-type.

Specified by:

setAgentCreatedPair in interface Partic

Parameters:

agent - the agent

created - the created

setAgentAffectedPair

public void setAgentAffectedPair(FD agent,
                                 FD affected)

A method to set the agent-affected pair; this is used when we have the dispositive effect-type.

Specified by:

setAgentAffectedPair in interface Partic

Parameters:

agent - the agent

affected - the affected

setProcessorPhenomenonPair

public void setProcessorPhenomenonPair(FD processor,
                                       FD phenom)

A method to set the processor-phenomenon pair; this is used when we have the mental process type.

Specified by:

setProcessorPhenomenonPair in interface Partic

Parameters:

processor - the processor

phenomenon - the phenomenon

setSayerAddresseePair

public void setSayerAddresseePair(FD sayer,
                                  FD addressee)

A method to set the sayer-addressee pair; this is used when we have the verbal process type.

Specified by:

setSayerAddresseePair in interface Partic

Parameters:

sayer - the sayer

addressee - the addressee

setSayerVerbalizationPair

public void setSayerVerbalizationPair(FD sayer,
                                      FD verbalization)

A method to set the sayer-verbalization pair; this is used when we have the verbal process type.

Specified by:

setSayerVerbalizationPair in interface Partic

Parameters:

sayer - the sayer

verbalization - the verbalization

setCarrierAttributePair

public void setCarrierAttributePair(FD carrier,
                                    FD attribute)

A method to set the carrier-attribute pair; this is used when we have the ascriptive process type and attributive effect-type.

Specified by:

setCarrierAttributePair in interface Partic

Parameters:

carrier - the carrier

attribute - the attribute

setIdentifiedIdentifierPair

public void setIdentifiedIdentifierPair(FD identified,
                                        FD identifier)

A method to set the identified-identifier pair; this is used when we have the ascriptive process type and the equative effect-type.

Specified by:

setIdentifiedIdentifierPair in interface Partic

Parameters:

identified - the identified

identifier - the identifier

setLocatedAccompanimentPair

public void setLocatedAccompanimentPair(FD located,
                                        FD accompaniment)

A method to set the located-accompaniment pair; this is used when you have the locative and accompaniment type.

Specified by:

setLocatedAccompanimentPair in interface Partic

Parameters:

located -

accompaniment -

setLocatedTimePair

public void setLocatedTimePair(FD located,
                               FD time)

A method to set the located-time pair; this is used when you have a locative and temporal type.

Specified by:

setLocatedTimePair in interface Partic

Parameters:

located -

time -

setLocatedLocationPair

public void setLocatedLocationPair(FD located,
                                   FD location)

A method to set the located-location pair; this is used when you have a spatial and attributive type.

Specified by:

setLocatedLocationPair in interface Partic

Parameters:

located -

location -

setPossessorPossessedPair

public void setPossessorPossessedPair(FD possessor,
                                      FD possessed)

A method to set the possessor-possessed pair; this is used when we have the possessive process type and attributive effect-type.

Specified by:

setPossessorPossessedPair in interface Partic

Parameters:

possessor - the possessor

possessed - the possessed