org.biopax.paxtools.pattern.constraint

Class Field

java.lang.Object

org.biopax.paxtools.pattern.constraint.ConstraintAdapter

org.biopax.paxtools.pattern.constraint.Field

All Implemented Interfaces:

Constraint

Direct Known Subclasses:

FieldOfMultiple

public class Field
extends ConstraintAdapter

Checks if an element has or has not a specific value for a field, or the field value of another element.

Author:

Ozgun Babur

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Field.Operation

Field Summary

Fields

Modifier and Type	Field and Description
static Object	EMPTY Possible parameter value indicating user desire the field to be empty.
static Object	USE_SECOND_ARG Possible parameter value indicating the desired value will be given as the second element to the constraint.

Fields inherited from class org.biopax.paxtools.pattern.constraint.ConstraintAdapter

blacklist, size

Constructor Summary

Constructors

Constructor and Description
Field(String accessorString, Field.Operation oper, Object value) Constructor with accessor string for the field value of the element and the desired value.
Field(String accessorString1, String accessorString2, Field.Operation oper) Constructor with accessor strings for the field value of the element and the desired value that will be reached from the second element.

Method Summary

Modifier and Type	Method and Description
boolean	satisfies(Match match, int... ind) Checks if the element in the first index has the desired value.

Methods inherited from class org.biopax.paxtools.pattern.constraint.ConstraintAdapter

assertIndLength, canGenerate, convertStepDirection, findDirectionInCatalysis, findDirectionInPathways, generate, getCatalysisDirection, getControlChain, getConvParticipants, getDirection, getDirection, getDirection, getDirection, getVariableSize, setSize

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final Object EMPTY

Possible parameter value indicating user desire the field to be empty.

USE_SECOND_ARG

public static final Object USE_SECOND_ARG

Possible parameter value indicating the desired value will be given as the second element to the constraint.

Constructor Detail

Field

public Field(String accessorString,
             Field.Operation oper,
             Object value)

Constructor with accessor string for the field value of the element and the desired value. If the desired value is EMPTY, then emptiness is checked. If it is USE_SECOND_ARG, then the second mapped element is used as the desired value. If a filed of the second element is desired then the other constructor should be used.

Parameters:

accessorString - accessor string for the element

oper - type of check

value - desired value

Field

public Field(String accessorString1,
             String accessorString2,
             Field.Operation oper)

Constructor with accessor strings for the field value of the element and the desired value that will be reached from the second element.

Parameters:

accessorString1 - accessor string for the first element

accessorString2 - accessor string for the second element

oper - type of check

Method Detail

satisfies

public boolean satisfies(Match match,
                         int... ind)

Checks if the element in the first index has the desired value.

Specified by:

satisfies in interface Constraint

Overrides:

satisfies in class ConstraintAdapter

Parameters:

match - current pattern match

ind - mapped indices

Returns:

true if the filed values contain the desired value, or empty as desired.