org.xmlecho.palomar.xfs
Interface CherryPicker

public interface CherryPicker

selectively harvests discreet branches from a collection in the repository

Field Summary

static short	COMPARE_BETWEEN
static short	COMPARE_EQUALS
static short	COMPARE_GREATER_EQUAL
static short	COMPARE_GREATER_THAN
static short	COMPARE_LESS_EQUAL
static short	COMPARE_LESS_THAN
static short	COMPARE_LIKE

Method Summary

boolean	getEmitDocIDsOnly()
void	pick(org.xml.sax.ContentHandler ch) select the nodes from XML documents in the repository, emitting the XML to the given content handler
void	setCollection(java.lang.String[] itemPaths) limit search to XML documents with names matching the listed patterns
void	setComparisonOperatorType(short type) the operator to be used in testing node text values for selection
void	setCousins(java.lang.String[] cousinPaths) return cousins of nodes with whose address match the orderPath expressions
void	setEmitDocIDsOnly(boolean flag) configure the picker to return only distinct DocIDs for those nodes which would be found by the query
void	setNodeAddresses(java.lang.String[] orderPaths) return only nodes whose address match the given orderPath expressions
void	setReturnNodeIDs(boolean doDecorate) indicate whether this should set attributes on returned elements containining unique node addresses
void	setValueExpressions(java.lang.String[] expression) return only nodes with values matching the given expressions
void	setXmlDocIDs(java.lang.String[] docIDs) pick only from docs with the given docIDs
void	setXPathSelections(java.lang.String[] selects) return only those nodes who match the structly limited (names only, no predicates) xpath patterns

Field Detail

COMPARE_EQUALS

public static final short COMPARE_EQUALS

See Also:

Constant Field Values

COMPARE_LESS_THAN

public static final short COMPARE_LESS_THAN

See Also:

Constant Field Values

COMPARE_LESS_EQUAL

public static final short COMPARE_LESS_EQUAL

See Also:

Constant Field Values

COMPARE_GREATER_THAN

public static final short COMPARE_GREATER_THAN

See Also:

Constant Field Values

COMPARE_GREATER_EQUAL

public static final short COMPARE_GREATER_EQUAL

See Also:

Constant Field Values

COMPARE_BETWEEN

public static final short COMPARE_BETWEEN

See Also:

Constant Field Values

COMPARE_LIKE

public static final short COMPARE_LIKE

See Also:

Constant Field Values

Method Detail

setCollection

public void setCollection(java.lang.String[] itemPaths)

limit search to XML documents with names matching the listed patterns

setXmlDocIDs

public void setXmlDocIDs(java.lang.String[] docIDs)

pick only from docs with the given docIDs

setValueExpressions

public void setValueExpressions(java.lang.String[] expression)

return only nodes with values matching the given expressions

setComparisonOperatorType

public void setComparisonOperatorType(short type)

the operator to be used in testing node text values for selection

setNodeAddresses

public void setNodeAddresses(java.lang.String[] orderPaths)

return only nodes whose address match the given orderPath expressions

setCousins

public void setCousins(java.lang.String[] cousinPaths)

return cousins of nodes with whose address match the orderPath expressions

Parameters:

cousinPaths - fully qualified name paths of nodes who must share a parent element with a matched order path

setXPathSelections

public void setXPathSelections(java.lang.String[] selects)

return only those nodes who match the structly limited (names only, no predicates) xpath patterns

setReturnNodeIDs

public void setReturnNodeIDs(boolean doDecorate)

indicate whether this should set attributes on returned elements containining unique node addresses

pick

public void pick(org.xml.sax.ContentHandler ch)

select the nodes from XML documents in the repository, emitting the XML to the given content handler

setEmitDocIDsOnly

public void setEmitDocIDsOnly(boolean flag)

configure the picker to return only distinct DocIDs for those nodes which would be found by the query

getEmitDocIDsOnly

public boolean getEmitDocIDsOnly()