edu.columbia.surge
Interface ProcFactory

All Known Implementing Classes:

ProcFactoryH

public abstract interface ProcFactory

This class holds the factory methods for the Proc class. Users can use this class to create instances of Proc objects with their desired parameters.

See Also:

Proc

Field Summary

static ProcFactory

factory The static instance which helps users to access to the methods in this class.

Method Summary

Proc	create() A factory method which creates a default instance of Proc.
Proc	create(java.lang.String type, java.lang.String lex) A factory method which takes in the lexical entry and the process type as parameters to compute and return an instance of Proc.
Proc	create(java.lang.String type, java.lang.String lex, java.lang.String effect_type, boolean agentive, boolean effective, java.lang.String mode, java.lang.String relation_type, java.lang.String polarity) A factory method to compute and return an instance of Proc that gives user the option to create an instance of Proc with all the most common and most frequently used properties.

Field Detail

factory

public static final ProcFactory factory

The static instance which helps users to access to the methods in this class.

Method Detail

create

public Proc create()

A factory method which creates a default instance of Proc.

Returns:

a default instance of Proc

create

public Proc create(java.lang.String type,
                   java.lang.String lex)
            throws InvalidConstructorException

A factory method which takes in the lexical entry and the process type as parameters to compute and return an instance of Proc. An exception will be thrown if the parameters are invalid.

Parameters:

type - the process type

lex - the lexical entry/verb of the process

Returns:

an instance of Proc

Throws:

InvalidConstructorException -

create

public Proc create(java.lang.String type,
                   java.lang.String lex,
                   java.lang.String effect_type,
                   boolean agentive,
                   boolean effective,
                   java.lang.String mode,
                   java.lang.String relation_type,
                   java.lang.String polarity)
            throws InvalidConstructorException

A factory method to compute and return an instance of Proc that gives user the option to create an instance of Proc with all the most common and most frequently used properties. If user does not want to specify certain properties, simply put in a null for that entry. However, as the minimum requirement for constructing a proc, user has to at least supply the type (process type) and the lexical entry. Otherwise, an InvalidConstructorException will be thrown.

Parameters:

type - the process type

lex - the lexical entry/verb of the process

effect_type - the effect type of the process

agentive - set whether the process is agentive

effective - set whether the process is effective

mode - the mode of the process

relation_type - the relation_type of the process

Returns:

an instance of Proc

Throws:

InvalidConstructorException -