edu.umd.cs.psl.model.predicate

Class PredicateFactory

java.lang.Object

edu.umd.cs.psl.model.predicate.PredicateFactory

public class PredicateFactory
extends Object

The factory for Predicates.

Uses the Singleton pattern, i.e., only one instance can exist, so use getFactory().

Ensures that a single Predicate object exists for each Predicate name.

Method Summary

Methods

Modifier and Type	Method and Description
ExternalFunctionalPredicate	createFunctionalPredicate(String name, ExternalFunction extFun) Constructs an ExternalFunctionalPredicate.
StandardPredicate	createStandardPredicate(String name, ArgumentType... types) Constructs a StandardPredicate.
static PredicateFactory	getFactory()
Iterable<FunctionalPredicate>	getFunctionalPredicates()
Predicate	getPredicate(String name) Gets the Predicate with the given name, if it exists
Iterable<Predicate>	getPredicates()
Iterable<StandardPredicate>	getStandardPredicates()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getFactory

public static PredicateFactory getFactory()

createStandardPredicate

public StandardPredicate createStandardPredicate(String name,
                                        ArgumentType... types)

Constructs a StandardPredicate.

Returns an existing StandardPredicate if one has the same name and ArgumentTypes.

Parameters:

name - name for the new predicate

types - types for each of the predicate's arguments

Returns:

the newly constructed Predicate

Throws:

IllegalArgumentException - if name is already used with different ArgumentTypes, is already used by another type of Predicate, doesn't match \w+; types has length zero; or an element of types is NULL

createFunctionalPredicate

public ExternalFunctionalPredicate createFunctionalPredicate(String name,
                                                    ExternalFunction extFun)

Constructs an ExternalFunctionalPredicate.

Returns an existing ExternalFunctionalPredicate if one has the same name and ExternalFunction.

Parameters:

name - name for the new predicate

extFun - the ExternalFunction the new predicate will use

Returns:

the newly constructed Predicate

Throws:

IllegalArgumentException - if name is already used with different ExternalFunction, is already used by another type of Predicate, doesn't match \w+; types has length zero; or extFun does not provide valid ArgumentTypes

getPredicate

public Predicate getPredicate(String name)

Gets the Predicate with the given name, if it exists

Parameters:

name - the name to match

Returns:

the Predicate, or NULL if no Predicate with that name exists

getFunctionalPredicates

public Iterable<FunctionalPredicate> getFunctionalPredicates()

getStandardPredicates

public Iterable<StandardPredicate> getStandardPredicates()

getPredicates

public Iterable<Predicate> getPredicates()

toString

public String toString()

Overrides:

toString in class Object