com.tridion.broker.querying.criteria.publication

Class PublicationPathCriteria

java.lang.Object

com.tridion.broker.querying.criteria.Criteria

com.tridion.broker.querying.criteria.publication.PublicationPathCriteria

public class PublicationPathCriteria
extends Criteria

This enables the broker query engine to retrieve content for a Publication path.
Examples:

• PublicationPathCriteria criteria = new PublicationPathCriteria("some path") will match all items from publication with path "some path".

Field Summary

Fields inherited from class com.tridion.broker.querying.criteria.Criteria

EQUAL, GREATER_OR_EQUAL_THAN, GREATER_THAN, LESS_OR_EQUAL_THAN, LESS_THAN, LIKE, NOT_EQUAL

Constructor Summary

Constructors

Constructor and Description
PublicationPathCriteria(String publicationPath) This constructs the PublicationPathCriteria with a specific PublicationPath.
PublicationPathCriteria(String publicationPath, FieldOperator operator) This constructs the PublicationPathCriteria with a specific publicationPath and a specific field operator.

Method Summary

Modifier and Type	Method and Description
String	getPublicationPath() This returns the publication path to use as the Criteria.
protected boolean	isLikeOperatorApplicable() Like operator is applicable to this criteria.
String	toString() Returns string presentation of the criteria.

Methods inherited from class com.tridion.broker.querying.criteria.Criteria

addCriteria, getCriteriaChildren, getCriteriaName, getFieldOperatorAsString, getParentOperator, getSignature, hasAnyCriteria, isOperator, setParentOperator

Methods inherited from class java.lang.Object

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

Constructor Detail

PublicationPathCriteria

public PublicationPathCriteria(String publicationPath)

This constructs the PublicationPathCriteria with a specific PublicationPath.

Parameters:

publicationPath - The publicationPath to query for

PublicationPathCriteria

public PublicationPathCriteria(String publicationPath,
                               FieldOperator operator)

This constructs the PublicationPathCriteria with a specific publicationPath and a specific field operator.

Parameters:

publicationPath - The publicationPath to query for.

operator - Operator for the queried title id (Criteria.EQUAL, Criteria.GREATER_THAN, ...).

Method Detail

getPublicationPath

public String getPublicationPath()

This returns the publication path to use as the Criteria.

Returns:

The publication path to use as the Criteria.

toString

public String toString()

Returns string presentation of the criteria.

Overrides:

toString in class Criteria

Returns:

String presentation of criteria.

isLikeOperatorApplicable

protected boolean isLikeOperatorApplicable()

Like operator is applicable to this criteria.

Overrides:

isLikeOperatorApplicable in class Criteria

Returns:

if the like operator is applicable. By default it is not applicable. This method should be overided by criteria classes.