org.fulib.patterns

Class PatternBuilder

java.lang.Object

org.fulib.patterns.PatternBuilder

public class PatternBuilder
extends java.lang.Object

Provides a DSL for constructing patterns.

Constructor Summary

Constructors

Constructor and Description
PatternBuilder()
PatternBuilder(java.lang.String packageName) Deprecated. since 1.2, use PatternBuilder() instead

Method Summary

Modifier and Type	Method and Description
PatternBuilder	buildAttibuteConstraint(java.util.function.Predicate<? super java.lang.Object> predicate, PatternObject object) Deprecated. since 1.2; use buildAttributeConstraint(PatternObject, Predicate) instead (typo "Att_ibute")
<T> PatternBuilder	buildAttributeConstraint(PatternObject object, java.lang.Class<T> type, java.util.function.Predicate<? super T> predicate) Creates a new, type-safe predicate/attribute constraint on the given pattern object that additionally does an instanceof check.
<T> PatternBuilder	buildAttributeConstraint(PatternObject object, java.util.function.Predicate<? super T> predicate) Creates a new predicate/attribute constraint on the given pattern object.
PatternBuilder	buildDistinctConstraint(PatternObject... objects) Constrains the given objects to be distinct.
PatternBuilder	buildEqualityConstraint(PatternObject object, java.lang.Object value) Constrains the given pattern object to be equal to the given value.
PatternBuilder	buildInstanceOfConstraint(PatternObject object, java.lang.Class<?> type) Constrains the given pattern object to be an instance of the given type.
PatternBuilder	buildMatchConstraint(java.util.function.Predicate<? super java.util.Map<java.lang.String,java.lang.Object>> predicate, PatternObject... objects) Creates a new match constraint on the given pattern object.
PatternBuilder	buildPatternLink(PatternObject src, PatternObject tgt) Creates a new link constraint between the given pattern objects with any link or attribute name in both directions.
PatternBuilder	buildPatternLink(PatternObject src, java.lang.String attrName, PatternObject tgt) Creates a new link constraint between the given pattern objects and with the expected attribute name.
PatternBuilder	buildPatternLink(PatternObject src, java.lang.String srcRoleName, java.lang.String tgtRoleName, PatternObject tgt) Creates a new link constraint between the given pattern objects and with the expected attribute name.
PatternObject	buildPatternObject(java.lang.String name) Creates a new pattern object with the given name.
PatternObject	buildPatternObject(java.lang.String name, java.lang.Class<?> type) Creates a new pattern object with the given name and adds an instance constraint for the given type.
Pattern	getPattern()
PatternMatcher	matcher()

Methods inherited from class java.lang.Object

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

Constructor Detail

PatternBuilder

public PatternBuilder()

Since:

1.2

PatternBuilder

@Deprecated
public PatternBuilder(java.lang.String packageName)

Deprecated. since 1.2, use PatternBuilder() instead

Parameters:

packageName - unused

Method Detail

getPattern

public Pattern getPattern()

Returns:

the pattern created by this builder. Modifications are reflected both ways.

buildPatternObject

public PatternObject buildPatternObject(java.lang.String name)

Creates a new pattern object with the given name.

Parameters:

name - the name of the pattern object

Returns:

the created pattern object

buildPatternObject

public PatternObject buildPatternObject(java.lang.String name,
                                        java.lang.Class<?> type)

Creates a new pattern object with the given name and adds an instance constraint for the given type.

Parameters:

name - the name of the pattern object

type - the type the pattern object is constraint to have

Returns:

the created pattern object

Since:

1.3

See Also:

buildPatternObject(String), buildInstanceOfConstraint(PatternObject, Class)

buildPatternLink

public PatternBuilder buildPatternLink(PatternObject src,
                                       PatternObject tgt)

Creates a new link constraint between the given pattern objects with any link or attribute name in both directions.

Equivalent to:

    this.buildPatternLink(src, "*", "*", tgt);
 

Parameters:

src - the source pattern object

tgt - the target pattern object

Returns:

this instance, to allow method chaining

Since:

1.3

buildPatternLink

public PatternBuilder buildPatternLink(PatternObject src,
                                       java.lang.String attrName,
                                       PatternObject tgt)

Creates a new link constraint between the given pattern objects and with the expected attribute name.

Parameters:

src - the source pattern object

attrName - the name of the attribute of the src object that should have the tgt value

tgt - the target pattern object

Returns:

this instance, to allow method chaining

Since:

1.2

buildPatternLink

public PatternBuilder buildPatternLink(PatternObject src,
                                       java.lang.String srcRoleName,
                                       java.lang.String tgtRoleName,
                                       PatternObject tgt)

Creates a new link constraint between the given pattern objects and with the expected attribute name.

Parameters:

src - the source pattern object

srcRoleName - the name of the property of the src object that should have the tgt value

tgtRoleName - the name of the property of the tgt object that should have the src value

tgt - the target pattern object

Returns:

this instance, to allow method chaining

buildAttibuteConstraint

@Deprecated
public PatternBuilder buildAttibuteConstraint(java.util.function.Predicate<? super java.lang.Object> predicate,
                                                          PatternObject object)

Deprecated. since 1.2; use buildAttributeConstraint(PatternObject, Predicate) instead (typo "Att_ibute")

Creates a new predicate/attribute constraint on the given pattern object.

Parameters:

predicate - the predicate on the value assigned to the pattern object

object - the pattern object

Returns:

this instance, to allow method chaining

buildAttributeConstraint

public <T> PatternBuilder buildAttributeConstraint(PatternObject object,
                                                   java.util.function.Predicate<? super T> predicate)

Creates a new predicate/attribute constraint on the given pattern object.

Type Parameters:

T - the type of objects expected to be passed to the predicate

Parameters:

object - the pattern object

predicate - the predicate on the value assigned to the pattern object

Returns:

this instance, to allow method chaining

Since:

1.2

buildAttributeConstraint

public <T> PatternBuilder buildAttributeConstraint(PatternObject object,
                                                   java.lang.Class<T> type,
                                                   java.util.function.Predicate<? super T> predicate)

Creates a new, type-safe predicate/attribute constraint on the given pattern object that additionally does an instanceof check.

Type Parameters:

T - the type of objects expected to be passed to the predicate

Parameters:

object - the pattern object

type - the type of objects expected to be passed to the predicate

predicate - the predicate on the value assigned to the pattern object

Returns:

this instance, to allow method chaining

Since:

1.3

buildEqualityConstraint

public PatternBuilder buildEqualityConstraint(PatternObject object,
                                              java.lang.Object value)

Constrains the given pattern object to be equal to the given value.

Equivalent to:

    this.buildAttributeConstraint(object, it -> Objects.equals(value, it));
 

Parameters:

object - the pattern object

value - the value

Returns:

this instance, to allow method chaining

Since:

1.3

buildInstanceOfConstraint

public PatternBuilder buildInstanceOfConstraint(PatternObject object,
                                                java.lang.Class<?> type)

Constrains the given pattern object to be an instance of the given type.

Equivalent to:

    this.buildAttributeConstraint(object, it -> superClass.isInstance(it));
 

Parameters:

object - the pattern object

type - the type

Returns:

this instance, to allow method chaining

Since:

1.3

buildMatchConstraint

public PatternBuilder buildMatchConstraint(java.util.function.Predicate<? super java.util.Map<java.lang.String,java.lang.Object>> predicate,
                                           PatternObject... objects)

Creates a new match constraint on the given pattern object.

Parameters:

predicate - the predicate on the values assigned to the pattern objects

objects - the pattern objects the constraint applies to

Returns:

this instance, to allow method chaining

buildDistinctConstraint

public PatternBuilder buildDistinctConstraint(PatternObject... objects)

Constrains the given objects to be distinct. That means n pattern objects must match n distinct objects, where equality is determined via equals and hashCode.

Parameters:

objects - the pattern objects that are constrained to be distinct

Returns:

this instance, to allow method chaining

Since:

1.3

matcher

public PatternMatcher matcher()

Returns:

a new matcher for the pattern created with this builder.

Since:

1.2