org.fulib.patterns

Class PatternMatcher

java.lang.Object

org.fulib.patterns.PatternMatcher

public class PatternMatcher
extends java.lang.Object

Allows matching object structures against patterns and retrieving values corresponding to pattern objects.

Constructor Summary

Constructors

Constructor and Description
PatternMatcher(Pattern pattern)

Method Summary

Modifier and Type	Method and Description
<T> java.util.Set<T>	findAll(PatternObject patternObject) Retrieves the matches for the given pattern object.
<T> T	findOne(PatternObject patternObject) Attempts to retrieve exactly one unique match for the given pattern object.
java.util.List<DebugEvent>	getDebugEvents()
ObjectTable	getMatchTable(PatternObject pattern)
java.util.LinkedHashMap<PatternObject,ObjectTable>	getObject2TableMap() Deprecated. since 1.2; for internal use only
java.util.List<java.lang.Object>	getRootObjects()
java.util.List<PatternObject>	getRootPatternObjects()
boolean	isDebugLogging()
void	match() Matches the pattern against the structure of objects that can be discovered from the root objects
ObjectTable	match(PatternObject rootPatternObject, java.lang.Object... rootObjects) Matches the pattern against the structure of objects that can be discovered from the root objects, and returns the table of matched values corresponding to the given pattern object.
ObjectTable	match(java.lang.String rootPatternObjectName, java.lang.Object... rootObjects) Matches the pattern against the structure of objects that can be discovered from the root objects, and returns the table of matched values corresponding to the named pattern object.
void	setDebugLogging(boolean eventLogging)
PatternMatcher	withRootObjects(java.util.Collection<?> objects)
PatternMatcher	withRootObjects(java.lang.Object... objects)
PatternMatcher	withRootObjects(java.lang.Object object)
PatternMatcher	withRootPatternObjects(java.util.Collection<? extends PatternObject> patternObjects)
PatternMatcher	withRootPatternObjects(PatternObject... patternObjects)
PatternMatcher	withRootPatternObjects(PatternObject patternObject)

Methods inherited from class java.lang.Object

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

Constructor Detail

PatternMatcher

public PatternMatcher(Pattern pattern)

Parameters:

pattern - the pattern

Method Detail

getObject2TableMap

@Deprecated
public java.util.LinkedHashMap<PatternObject,ObjectTable> getObject2TableMap()

Deprecated. since 1.2; for internal use only

Returns:

the map from pattern object to tables of matching values

isDebugLogging

public boolean isDebugLogging()

Returns:

true if debug logging is enabled

Since:

1.3

setDebugLogging

public void setDebugLogging(boolean eventLogging)

Parameters:

eventLogging - determines whether debug logging is on (true) or off (false)

Since:

1.3

getDebugEvents

public java.util.List<DebugEvent> getDebugEvents()

Returns:

the list of debug events that happened during the match process. Empty if debug logging is turned off, or when match() or its variants have not been called yet.

Since:

1.3

getRootPatternObjects

public java.util.List<PatternObject> getRootPatternObjects()

Returns:

the root pattern objects

Since:

1.3

withRootPatternObjects

public PatternMatcher withRootPatternObjects(PatternObject patternObject)

Parameters:

patternObject - the root pattern object to add

Returns:

this instance, to allow method chaining

Since:

1.3

withRootPatternObjects

public PatternMatcher withRootPatternObjects(PatternObject... patternObjects)

Parameters:

patternObjects - the root pattern objects to add

Returns:

this instance, to allow method chaining

Since:

1.3

withRootPatternObjects

public PatternMatcher withRootPatternObjects(java.util.Collection<? extends PatternObject> patternObjects)

Parameters:

patternObjects - the root pattern objects to add

Returns:

this instance, to allow method chaining

Since:

1.3

getRootObjects

public java.util.List<java.lang.Object> getRootObjects()

Returns:

the root objects

Since:

1.3

withRootObjects

public PatternMatcher withRootObjects(java.lang.Object object)

Parameters:

object - the root object to add

Returns:

this instance, to allow method chaining

Since:

1.3

withRootObjects

public PatternMatcher withRootObjects(java.lang.Object... objects)

Parameters:

objects - the root objects to add

Returns:

this instance, to allow method chaining

Since:

1.3

withRootObjects

public PatternMatcher withRootObjects(java.util.Collection<?> objects)

Parameters:

objects - the root objects to add

Returns:

this instance, to allow method chaining

Since:

1.3

match

public ObjectTable match(java.lang.String rootPatternObjectName,
                         java.lang.Object... rootObjects)

Matches the pattern against the structure of objects that can be discovered from the root objects, and returns the table of matched values corresponding to the named pattern object.

Equivalent to:

    this.match(pattern.getObject(rootPatternObjectName), rootObjects);
 

Parameters:

rootPatternObjectName - the name of the root pattern object, and for which the results are requested for

rootObjects - the root objects for object structure discovery

Returns:

the table of matched values corresponding to the named pattern object

Throws:

NoApplicableConstraintException - if there were unmatched constraints, possibly due to disconnected pattern objects

See Also:

match(PatternObject, Object...)

match

public ObjectTable match(PatternObject rootPatternObject,
                         java.lang.Object... rootObjects)

Matches the pattern against the structure of objects that can be discovered from the root objects, and returns the table of matched values corresponding to the given pattern object.

Equivalent to:

    this.withRootPatternObjects(rootPatternObject);
    this.withRootObjects(rootObjects);
    this.match();
    return this.getMatchTable(rootPatternObject);
 

Parameters:

rootPatternObject - the root pattern object, and for which the results are requested for

rootObjects - the root objects for object structure discovery

Returns:

the table of matched values corresponding to the given pattern object

Throws:

NoApplicableConstraintException - if there were unmatched constraints, possibly due to disconnected pattern objects

Since:

1.2

match

public void match()

Matches the pattern against the structure of objects that can be discovered from the root objects

Throws:

NoApplicableConstraintException - if there were unmatched constraints, possibly due to disconnected pattern objects

Since:

1.3

getMatchTable

public ObjectTable getMatchTable(PatternObject pattern)

Parameters:

pattern - the pattern object

Returns:

the table of matching values, or null if the pattern object was not reached

Since:

1.2

findOne

public <T> T findOne(PatternObject patternObject)

Attempts to retrieve exactly one unique match for the given pattern object. Must be called after match() or its variants.

Type Parameters:

T - the expected type of the result

Parameters:

patternObject - the pattern object results are requested for

Returns:

the match for the given pattern object

Throws:

NoMatchException - if no objects match

AmbiguousMatchException - if more than one distinct objects match

Since:

1.3

findAll

public <T> java.util.Set<T> findAll(PatternObject patternObject)

Retrieves the matches for the given pattern object. Must be called after match() or its variants.

Type Parameters:

T - the expected type of the results

Parameters:

patternObject - the pattern object results are requested for

Returns:

the matches for the given pattern object. May be empty.

Since:

1.3