Package com.ptc.core.query.common

Interface CriterionSpec

All Known Implementing Classes:
BasicCriteriaSpec, CompositeCriteriaSpec, DefaultCriteriaSpec
public interface CriterionSpec
This interface provides the abstraction for specifying the criteria for a type based query. The criteria are AttributeContainerSet instances associated with a specified TypeIdentifier.

Supported API: true

Extendable: true

  • Method Details

    • getTypes

      Set<TypeIdentifier> getTypes() throws WTException
      This method returns the set of TypeIdentifier that have specified criteria.

      Supported API: true
      Returns:
      Set of TypeIdentifiers
      Throws:
      WTException

    • getCriteria

      AttributeContainerSet getCriteria(TypeIdentifier a_targetTypeId) throws WTException
      This method returns the criteria associated with a specified TypeIdentifier.

      Supported API: true
      Parameters:
      a_targetTypeId - specifies the target TypeIdentifier
      Returns:
      AttributeContainerSet
      Throws:
      WTException

    • containsCriteria

      boolean containsCriteria() throws WTException
      This method returns true if any criteria exist.

      Supported API: true
      Returns:
      true if any criteria exists
      Throws:
      WTException

    • containsOuterJoin

      boolean containsOuterJoin() throws WTException
      This method returns true if any of the associated criteria contains outer join criterion.

      Supported API: true
      Returns:
      true if any of the associated criteria contains outer join criterion
      Throws:
      WTException

    • cloneNonRoot

      CriterionSpec cloneNonRoot() throws WTException
      This method creates a copy of this instance that contains only non root criteria.

      Supported API: true
      Returns:
      copy of this instance that contains only non root criteria
      Throws:
      WTException

    • iterator

      Iterator<AttributeContainerSet> iterator() throws WTException
      This method iterates over all criteria.

      Supported API: true
      Returns:
      iterator over all criteria
      Throws:
      WTException

    • augmentCriteria

      void augmentCriteria(CriteriaAugmentor a_augmentor, ResultSpec a_resultSpec) throws WTException
      This method augments all criteria.

      Supported API: true
      Parameters:
      a_augmentor - specifies the augmentor to use
      a_resultSpec - specifies the result to use
      Throws:
      WTException