Module org.refcodes.criteria

Package org.refcodes.criteria

Class AbstractCriteriaNode

java.lang.Object

org.refcodes.criteria.AbstractCriteria

org.refcodes.criteria.AbstractCriteriaNode

All Implemented Interfaces:

Criteria, CriteriaNode, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.Schemable<CriteriaSchema>

Direct Known Subclasses:

AndCriteria, IntersectWithCriteria, NotCriteria, OrCriteria

public abstract class AbstractCriteriaNode
extends AbstractCriteria
implements CriteriaNode

Base class with the base functionality provided for CriteriaNode implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.AliasAccessor

org.refcodes.mixin.AliasAccessor.AliasBuilder<B extends org.refcodes.mixin.AliasAccessor.AliasBuilder<B>>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Criteria>	_children

Constructor Summary

Constructors

Constructor	Description
AbstractCriteriaNode(String aAlias)	Constructs a CriteriaNode with the given name.
AbstractCriteriaNode(String aAlias, List<Criteria> aChildren)	Constructs a CriteriaNode with the given name and the backing(!)
AbstractCriteriaNode(String aAlias, Criteria... aChildren)	Constructs a CriteriaNode with the given name and the provided Criteria children.

Method Summary

Modifier and Type	Method	Description
void	addChild(Criteria aChild)	Adds a child Criteria to the CriteriaNode.
List<Criteria>	getChildren()	Returns the list of child Criteria instances contained in the CriteriaNode.
CriteriaSchema	toSchema(String aDescription)	Creates a CriteriaSchema for a CriteriaNode sub-class with the instance's type and alias as well as the provided description.

Methods inherited from class org.refcodes.criteria.AbstractCriteria

getAlias

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.mixin.AliasAccessor

getAlias

Methods inherited from interface org.refcodes.mixin.Schemable

toSchema

Field Details

_children

protected List<Criteria> _children

Constructor Details

AbstractCriteriaNode

public AbstractCriteriaNode(String aAlias)

Constructs a CriteriaNode with the given name.

Parameters:

aAlias - The name of the CriteriaNode.

AbstractCriteriaNode

public AbstractCriteriaNode(String aAlias,
 Criteria... aChildren)

Constructs a CriteriaNode with the given name and the provided Criteria children.

Parameters:

aAlias - The name of the CriteriaNode.

aChildren - The Criteria children to be contained in the CriteriaNode.

AbstractCriteriaNode

public AbstractCriteriaNode(String aAlias,
 List<Criteria> aChildren)

Constructs a CriteriaNode with the given name and the backing(!) List of the Criteria children to be provided: The getChildren() method will return the backing List as given, so you may provide an unmodifiable List if needed!

Parameters:

aAlias - The name of the CriteriaNode.

aChildren - The backing(!) List of the Criteria children to be used by the CriteriaNode.

Method Details

addChild

public void addChild(Criteria aChild)
              throws IllegalStateException,
IllegalArgumentException

Adds a child Criteria to the CriteriaNode. In case a https://www.metacodes.proized CriteriaNode applies constraints on the number or type of Criteria which may be added, an according exception may be thrown. For example a single CriteriaNode may apply constraints on this method.

Specified by:

addChild in interface CriteriaNode

Parameters:

aChild - The child Criteria to be added.

Throws:

IllegalStateException - In case constraints in terms of state are violated, implementation depended.

IllegalArgumentException - In case constraints in terms of argument are violated, implementation depended.

getChildren

public List<Criteria> getChildren()

Returns the list of child Criteria instances contained in the CriteriaNode.

Specified by:

getChildren in interface CriteriaNode

Returns:

The Criteria instances contained in the CriteriaNode.

toSchema

public CriteriaSchema toSchema(String aDescription)

Creates a CriteriaSchema for a CriteriaNode sub-class with the instance's type and alias as well as the provided description.

Parameters:

aDescription - The description to use for the Schema instance.

Returns:

The according Schema instance.