edu.columbia.surge
Interface CircumFactory

All Known Implementing Classes:

CircumFactoryH

public abstract interface CircumFactory

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

See Also:

Circum

Field Summary

static CircumFactory

factory

Method Summary

Circum	create() The default factory method which creates an default instance of Circum object without any parameters.
Circum	create(FD behalf, FD effect, FD inLoc, FD manner, FD purpose, FD reason, FD time, java.lang.String lex) The factory method which creates an instance of Circums object with the given entries that tell and specify the circumstance.
Circum	create(java.lang.String propertyName, FD propertyBody, java.lang.String lex) The factory method which creates an instance of Circum object with the given entries that tell and specify the circumstance.

Field Detail

factory

public static final CircumFactory factory

Method Detail

create

public Circum create()

The default factory method which creates an default instance of Circum object without any parameters.

Returns:

a default instance of Circum.

create

public Circum create(java.lang.String propertyName,
                     FD propertyBody,
                     java.lang.String lex)
              throws InvalidConstructorException

The factory method which creates an instance of Circum object with the given entries that tell and specify the circumstance. If invalid parameters are input, an exception will be thrown.

Parameters:

propertyName - the name of the circumstance property

propertyBody - the body of the circumstance property

lex - the possible lexical entry of the circumstance

Returns:

an instance of Circum instantiated with the property name and the specified properties.

Throws:

InvalidConstructorException -

create

public Circum create(FD behalf,
                     FD effect,
                     FD inLoc,
                     FD manner,
                     FD purpose,
                     FD reason,
                     FD time,
                     java.lang.String lex)
              throws InvalidConstructorException

The factory method which creates an instance of Circums object with the given entries that tell and specify the circumstance. This constructor accounts for all possible cirsumtances that users can specify. Among all the possible input circumstance characteristics, users should only enter one characteristic and set the rest of them be null. Otherwise, if more than one characteristics is inputted, an exception should be thrown. If invalid parameters are input, an exception will be thrown.

Parameters:

behalf - the behalf characteristics of the circumstance

effect - the effect characteristics of the circumstance

inLoc - the in-location characteristics of the circumstance

manner - the manner characteristics of the circumstance

purpose - the purpose characteristics of the circumstance

reason - the reason characteristics of the circumstance

time - the time characteristics of the circumstance

lex - the possible lexical entry of the circumstance

Returns:

an instance of Circum instantiated with the property name and the specified properties.

Throws:

InvalidConstructorException -