com.yahoo.document.select

Class DocumentSelector

java.lang.Object

com.yahoo.document.select.DocumentSelector

public class DocumentSelector
extends Object

A document selector is a filter which accepts or rejects documents based on their type and content. A document selector has a textual representation which is called the Document Selection Language

Document selectors are multithread safe.

Author:

bratseth

Field Summary

Fields

Modifier and Type	Field and Description
private ExpressionNode	expression

Constructor Summary

Constructors

Constructor and Description
DocumentSelector(String selector) Creates a document selector from a Document Selection Language string

Method Summary

Modifier and Type	Method and Description
Result	accepts(Context context) Returns true if the document referenced by this context is accepted by this selector
Result	accepts(DocumentOperation op) Returns true if the document referenced by this document operation is accepted by this selector
ResultList	getMatchingResultList(Context context) Returns the list of different variables resulting in a true state for this expression.
ResultList	getMatchingResultList(DocumentOperation op) Returns the list of different variables resulting in a true state for this expression.
OrderingSpecification	getOrdering(int order) Returns the ordering specification, if any, implied by this document selection expression.
String	toString() Returns this selector as a Document Selection Language string.
void	visit(Visitor visitor) Visits the expression tree.

Methods inherited from class java.lang.Object

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

Field Detail

expression

private ExpressionNode expression

Constructor Detail

DocumentSelector

public DocumentSelector(String selector)
                 throws ParseException

Creates a document selector from a Document Selection Language string

Parameters:

selector - The string to parse as a selector.

Throws:

ParseException - Thrown if the string could not be parsed.

Method Detail

accepts

public Result accepts(DocumentOperation op)

Returns true if the document referenced by this document operation is accepted by this selector

Parameters:

op - A document operation

Returns:

True if the document is accepted.

Throws:

RuntimeException - if the evaluation enters an illegal state

accepts

public Result accepts(Context context)

Returns true if the document referenced by this context is accepted by this selector

Parameters:

context - The context to match in.

Returns:

True if the document is accepted.

Throws:

RuntimeException - if the evaluation enters an illegal state

getMatchingResultList

public ResultList getMatchingResultList(DocumentOperation op)

Returns the list of different variables resulting in a true state for this expression.

Parameters:

op - The document to evaluate.

Returns:

True if the document is accepted.

Throws:

RuntimeException - if the evaluation enters an illegal state

getMatchingResultList

public ResultList getMatchingResultList(Context context)

Returns the list of different variables resulting in a true state for this expression.

Parameters:

context - The context to match in.

Returns:

True if the document is accepted.

Throws:

RuntimeException - if the evaluation enters an illegal state

toString

public String toString()

Returns this selector as a Document Selection Language string.

Overrides:

toString in class Object

Returns:

The selection string.

getOrdering

public OrderingSpecification getOrdering(int order)

Returns the ordering specification, if any, implied by this document selection expression.

Parameters:

order - The order of the

visit

public void visit(Visitor visitor)

Visits the expression tree.

Parameters:

visitor - The visitor to use.