edu.columbia.surge.hashImpl
Class ProcFactoryH

java.lang.Object
  |
  +--edu.columbia.surge.hashImpl.ProcFactoryH

public class ProcFactoryH

extends java.lang.Object

implements 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. A static keyword is used to instantiate an instance of ProcFactoryH so that the static variable "factory" in this class will have access to the create methods. Users can also create instances of ProcH directly using the constructors of the Proc class. The primary reason of the creation of this class is to allow the Proc class, which implements the Proc interface to have constructors while being able to implement all the methods in the interface.

See Also:

ProcH

Field Summary

static ProcFactoryH

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 ProcFactoryH.
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 ProcH.
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 ProcH that gives user the option to create an instance of ProcH with all the most common and most frequently used properties.

Methods inherited from class java.lang.Object

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

Field Detail

factory

public static ProcFactoryH 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 ProcFactoryH.

Specified by:

create in interface ProcFactory

Returns:

a default instance of ProcFactoryH

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 ProcH. An exception will be thrown if the parameters are invalid.

Specified by:

create in interface ProcFactory

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 ProcH that gives user the option to create an instance of ProcH 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.

Specified by:

create in interface ProcFactory

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 -