org.licas_text.query.model

Class PatternElement

java.lang.Object

org.licas_text.query.model.QueryElement

org.licas_text.query.model.PatternElement

public class PatternElement
extends QueryElement

This defines a pattern element in the QueryModel query model. A pattern is a description of an element that you wish to search for. It can be defined by its value at least. It can also store a number of value or attribute constraints, or conditions, that should be satisfied. These are stored as AttributeConstraint or PatternConstraint elements and relate to this pattern only.

Author:

Kieran Greer.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<AttributeConstraint>	attrConstraints A list of constraints that need to be satisfied on element attributes.
int	level Nesting level for this pattern.
protected java.util.ArrayList<PatternElement>	nested List of nested patterns
protected java.util.ArrayList<PatternConstraint>	valueConstraints A list of constraints that need to be satisfied on the pattern value.

Fields inherited from class org.licas_text.query.model.QueryElement

caseSensitive, name, typeCondition, value, valueType, wildcards

Constructor Summary

Constructors

Constructor and Description
PatternElement(java.lang.String type) Create a new instance of PatternElement.

Method Summary

Modifier and Type	Method and Description
boolean	addValueConstraint(PatternConstraint constraintToAdd) Add a new pattern constraint.
boolean	containsValueConstraint(java.lang.String constraintType) Return true if the pattern element contains a constraint of the specified typeCondition.
java.util.ArrayList<AttributeConstraint>	getAttrConstraints() Get all attribute constraints.
java.util.ArrayList<PatternElement>	getNested() Get all nested patterns.
java.lang.String	getValue() Get the element value.
PatternConstraint	getValueConstraint(java.lang.String constraintType) Return the first constraint of the specified typeCondition.
java.util.ArrayList<PatternConstraint>	getValueConstraints() Get all value constraints.
java.util.ArrayList<PatternConstraint>	getValueConstraints(java.lang.String constraintType) Return all constraints of the specified typeCondition.
void	setAttrConstraints(java.util.ArrayList<AttributeConstraint> thisAttrConstraints) Set the list of attribute constraints.
void	setValue(java.lang.String thisValue) Set the element name.
void	setValueConstraints(java.util.ArrayList<PatternConstraint> thisValueConstraints) Set the list of value constraints.

Methods inherited from class org.licas_text.query.model.QueryElement

getCase, getName, getTypeOrCondition, getValueType, getWildcards, setBooleans, setName, setValueType

Methods inherited from class java.lang.Object

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

Field Detail

attrConstraints

protected java.util.ArrayList<AttributeConstraint> attrConstraints

A list of constraints that need to be satisfied on element attributes. Of type AttributeConstraint.

valueConstraints

protected java.util.ArrayList<PatternConstraint> valueConstraints

A list of constraints that need to be satisfied on the pattern value. Of type PatternConstraint.

nested

protected java.util.ArrayList<PatternElement> nested

List of nested patterns

level

public int level

Nesting level for this pattern. Not a permanent feature but used during processing.

Constructor Detail

PatternElement

public PatternElement(java.lang.String type)

Create a new instance of PatternElement.

Parameters:

type - the type of query evaluation for the pattern, for example QueryConst.XML, TEXT, ASTEXT or NUMERICAL. Can be null.

Method Detail

containsValueConstraint

public boolean containsValueConstraint(java.lang.String constraintType)

Return true if the pattern element contains a constraint of the specified typeCondition.

Parameters:

constraintType - the constraint typeCondition.

Returns:

true if the pattern contains a constraint of that typeCondition.

addValueConstraint

public boolean addValueConstraint(PatternConstraint constraintToAdd)

Add a new pattern constraint.

Parameters:

constraintToAdd - the constraint to add.

Returns:

true if added or false if the constraint typeCondition has already been added.

getValueConstraint

public PatternConstraint getValueConstraint(java.lang.String constraintType)

Return the first constraint of the specified typeCondition.

Parameters:

constraintType - the constraint typeCondition.

Returns:

a the first constraint of that typeCondition, or null if none exist.

getValueConstraints

public java.util.ArrayList<PatternConstraint> getValueConstraints(java.lang.String constraintType)

Return all constraints of the specified typeCondition.

Parameters:

constraintType - the constraint typeCondition.

Returns:

a list of all constraints of that typeCondition.

setValueConstraints

public void setValueConstraints(java.util.ArrayList<PatternConstraint> thisValueConstraints)

Set the list of value constraints.

Parameters:

thisValueConstraints - the list of value constraints.

getValueConstraints

public java.util.ArrayList<PatternConstraint> getValueConstraints()

Get all value constraints.

Returns:

the value of valueConstraints.

setAttrConstraints

public void setAttrConstraints(java.util.ArrayList<AttributeConstraint> thisAttrConstraints)

Set the list of attribute constraints.

Parameters:

thisAttrConstraints - the list of attribute constraints.

getAttrConstraints

public java.util.ArrayList<AttributeConstraint> getAttrConstraints()

Get all attribute constraints.

Returns:

the value of attrConstraints.

setValue

public void setValue(java.lang.String thisValue)

Set the element name. For a Pattern element, the name and the value are the same and so this calls setName() to set the value.

Overrides:

setValue in class QueryElement

Parameters:

thisValue - the element value.

getValue

public java.lang.String getValue()

Get the element value. For a Pattern element, the name and the value are the same and so this calls getName() to get the reply.

Overrides:

getValue in class QueryElement

Returns:

the name of the element.

getNested

public java.util.ArrayList<PatternElement> getNested()

Get all nested patterns.

Returns:

the value of nested.