Package com.ptc.core.query.common

Class DefaultCriteriaSpec

java.lang.Object

com.ptc.core.query.common.DefaultCriteriaSpec

All Implemented Interfaces:

CriterionSpec, Serializable

public class DefaultCriteriaSpec
extends Object
implements CriterionSpec, Serializable

This class provides a default implementation for specifying the criteria for a type based query. A single AttributeContainerSet instance is returned for any TypeIdentifier that is specified.

Supported API: true

Extendable: true

See Also:

• Serialized Form

Field Summary

Fields inherited from interface com.ptc.core.query.common.CriterionSpec

LOGGER_NAME

Constructor Summary

Constructors

Constructor	Description
DefaultCriteriaSpec(AttributeContainerSet a_criteria)	This constructor initializes the instance using the specified criteria.

Method Summary

Modifier and Type	Method	Description
void	augmentCriteria(CriteriaAugmentor a_augmentor, ResultSpec a_resultSpec)	This method augments all criteria.
CriterionSpec	cloneNonRoot()	This method creates a copy of this instance that contains only non root criteria.
boolean	containsCriteria()	This method returns true if any criteria exist.
boolean	containsOuterJoin()	This method returns true if any of the associated criteria contains outer join criterion.
AttributeContainerSet	getCriteria(TypeIdentifier a_targetTypeId)	This method returns the criteria associated with a specified TypeIdentifier.
Set<TypeIdentifier>	getTypes()	This method returns the set of TypeIdentifier that have specified criteria.
Iterator<AttributeContainerSet>	iterator()	This method iterates over all criteria.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultCriteriaSpec

public DefaultCriteriaSpec(AttributeContainerSet a_criteria)
                    throws WTException

This constructor initializes the instance using the specified criteria.

Supported API: true

Parameters:

a_criteria - specifies the criteria

Throws:

WTException

Method Details

getTypes

public Set<TypeIdentifier> getTypes()
                             throws WTException

This method returns the set of TypeIdentifier that have specified criteria.

Supported API: true

Specified by:

getTypes in interface CriterionSpec

Returns:

Set of TypeIdentifiers

Throws:

WTException

getCriteria

public AttributeContainerSet getCriteria(TypeIdentifier a_targetTypeId)
                                  throws WTException

This method returns the criteria associated with a specified TypeIdentifier.

Supported API: true

Specified by:

getCriteria in interface CriterionSpec

Parameters:

a_targetTypeId - specifies the target TypeIdentifier

Returns:

AttributeContainerSet

Throws:

WTException

containsCriteria

public boolean containsCriteria()
                         throws WTException

This method returns true if any criteria exist.

Supported API: true

Specified by:

containsCriteria in interface CriterionSpec

Returns:

true if any criteria exists

Throws:

WTException

containsOuterJoin

public boolean containsOuterJoin()
                          throws WTException

This method returns true if any of the associated criteria contains outer join criterion.

Supported API: true

Specified by:

containsOuterJoin in interface CriterionSpec

Returns:

true if any of the associated criteria contains outer join criterion

Throws:

WTException

cloneNonRoot

public CriterionSpec cloneNonRoot()
                           throws WTException

This method creates a copy of this instance that contains only non root criteria.

Supported API: true

Specified by:

cloneNonRoot in interface CriterionSpec

Returns:

copy of this instance that contains only non root criteria

Throws:

WTException

iterator

public Iterator<AttributeContainerSet> iterator()
                                         throws WTException

This method iterates over all criteria.

Supported API: true

Specified by:

iterator in interface CriterionSpec

Returns:

iterator over all criteria

Throws:

WTException

augmentCriteria

public void augmentCriteria(CriteriaAugmentor a_augmentor,
 ResultSpec a_resultSpec)
                     throws WTException

This method augments all criteria.

Supported API: true

Specified by:

augmentCriteria in interface CriterionSpec

Parameters:

a_augmentor - specifies the augmentor to use

a_resultSpec - specifies the result to use

Throws:

WTException