com.articulate.sigma.nlg

Class SumoProcessCollector

java.lang.Object

com.articulate.sigma.nlg.SumoProcessCollector

public class SumoProcessCollector
extends java.lang.Object

This object represents a process or an event, holding information on its case roles as well as the entities which play that role.

Constructor Summary

Constructors

Constructor and Description
SumoProcessCollector(KB kb, java.lang.String role, java.lang.String process, java.lang.String entity) Construct a SumoProcessCollector.

Method Summary

Modifier and Type	Method and Description
void	addRole(java.lang.String role, java.lang.String arg) Add a new role/entity pair to this event.
VerbProperties.Polarity	getPolarity() Getter and setter for polarity field.
static java.lang.String	getProperFormOfEntity(java.lang.String entity, KB kb) Retain capitalization of names and reified instances by lower-casing if the entity is an Entity.
com.google.common.collect.Multimap<CaseRole,java.lang.String>	getRolesAndEntities() Get all the roles and their entities for this event.
SumoProcess	getSumoProcess()
void	merge(SumoProcessCollector newProcessCollector) Merge the roles of the given SumoProcessCollector into this object.
void	setEntityProperties(com.google.common.collect.Multimap<java.lang.String,SumoProcessEntityProperty> properties) Translate this process and its case roles into natural language.
void	setPolarity(VerbProperties.Polarity polarity)
java.lang.String	toNaturalLanguage() Translate this process and its case roles into natural language.
java.lang.String	toString() Write out a string representing all the fields in this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SumoProcessCollector

public SumoProcessCollector(KB kb,
                            java.lang.String role,
                            java.lang.String process,
                            java.lang.String entity)

Construct a SumoProcessCollector.

Parameters:

kb -

role -

process -

entity -

Method Detail

getSumoProcess

public SumoProcess getSumoProcess()

Returns:

getPolarity

public VerbProperties.Polarity getPolarity()

Getter and setter for polarity field.

setPolarity

public void setPolarity(VerbProperties.Polarity polarity)

addRole

public void addRole(java.lang.String role,
                    java.lang.String arg)

Add a new role/entity pair to this event.

Parameters:

role -

arg -

getRolesAndEntities

public com.google.common.collect.Multimap<CaseRole,java.lang.String> getRolesAndEntities()

Get all the roles and their entities for this event.

Returns:

getProperFormOfEntity

public static java.lang.String getProperFormOfEntity(java.lang.String entity,
                                                     KB kb)

Retain capitalization of names and reified instances by lower-casing if the entity is an Entity.

Parameters:

entity -

Returns:

toString

public java.lang.String toString()

Write out a string representing all the fields in this object.

Overrides:

toString in class java.lang.Object

Returns:

toNaturalLanguage

public java.lang.String toNaturalLanguage()

Translate this process and its case roles into natural language.

Returns:

a natural language translation, or empty string if one is not possible

setEntityProperties

public void setEntityProperties(com.google.common.collect.Multimap<java.lang.String,SumoProcessEntityProperty> properties)

Translate this process and its case roles into natural language.

Parameters:

properties -

merge

public void merge(SumoProcessCollector newProcessCollector)

Merge the roles of the given SumoProcessCollector into this object. If new SumoProcessCollector's polarity is Negative, set this object's to the same.

Parameters:

newProcessCollector -