jFUF API (alpha 1.0): Interface Partic

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

edu.columbia.surge
Interface Partic

All Known Implementing Classes:: ParticH

public abstract interface Partic
extends FD

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. User can either use the ParticFactory class or directly use the constructor of this class to create instances of Partic.

See Also:: ParticFactory, Clause, Proc

Inner classes inherited from class java.util.Map

java.util.Map.Entry

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 phenomenon)` 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 phenomenon)` 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 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

setAgent

public void setAgent(FD agent)

A method to set the agent of the participant

Parameters:: agent - the agent of the participant

setRange

public void setRange(FD range)

A method to set the range of the participant

Parameters:: range - the range of the participant

setCreated

public void setCreated(FD created)

A method to set the created of the participant

Parameters:: created - the created of the participant

setAffected

public void setAffected(FD affected)

A method to set the affected of the participant

Parameters:: affected - the affected of the participant

setProcessor

public void setProcessor(FD processor)

A method to set the processor of the participant

Parameters:: processor - the processor of the participant

setPhenomenon

public void setPhenomenon(FD phenomenon)

A method to set the phenomenon of the participant

Parameters:: phenomenon - the phenomenon of the participant

setSayer

public void setSayer(FD sayer)

A method to set the sayer of the participant

Parameters:: sayer - the sayer of the participant

setAddressee

public void setAddressee(FD addressee)

A method to set the addressee of the participant

Parameters:: addressee - the addressee of the participant

setVerbalization

public void setVerbalization(FD verbalization)

A method to set the verbalization of the participant

Parameters:: verbalization - the verbalization of the participant

setCarrier

public void setCarrier(FD carrier)

A method to set the carrier of the participant

Parameters:: carrier - the carrier of the participant

setAttribute

public void setAttribute(FD attribute)

A method to set the attribute of the participant

Parameters:: attribute - the attribute of the participant

setIdentified

public void setIdentified(FD identified)

A method to set the identified of the participant

Parameters:: identified - the identified of the participant

setIdentifier

public void setIdentifier(FD identifier)

A method to set the identifier of the partic

Parameters:: identifier - the identifier of the partic

setPossessor

public void setPossessor(FD possessor)

A method to set the possessor of the partic

Parameters:: possessor - the possessor of the partic

setPossessed

public void setPossessed(FD possessed)

A method to set the possessed of the partic

Parameters:: possessed - the possessed of the partic

setLocated

public void setLocated(FD located)

A method to set the located of the partic

Parameters:: located - the located of the partic

setAccompaniment

public void setAccompaniment(FD accompaniment)

A method to set the accompaniment

Parameters:: accompaniment - the accompaniment

setTime

public void setTime(FD time)

A method to set the time

Parameters:: time - the time

setLocation

public void setLocation(FD location)

A method to set the location

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.

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.

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.

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.

Parameters:: agent - the agent; affected - the affected

setProcessorPhenomenonPair

public void setProcessorPhenomenonPair(FD processor,
                                       FD phenomenon)

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

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.

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.

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.

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.

Parameters:: identified - the identified; identifier - the identifier

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.

Parameters:: possessor - the possessor; possessed - the possessed

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.

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.

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.

Parameters:: located -; location -