eu.dnetlib.functionality.index.query

Class Pruner

java.lang.Object

eu.dnetlib.functionality.index.query.Pruner

public class Pruner
extends Object

Use this class to cleanup a CQL tree and obtain all the options

Author:

marko & claudio

Field Summary

Fields

Modifier and Type	Field and Description
static String	DNET_URI All options have to be in this namespace.

Constructor Summary

Constructors

Constructor and Description
Pruner()

Method Summary

Modifier and Type	Method and Description
<T> T	anyNotNull(T a, T b)
String	getOption(org.z3950.zing.cql.CQLNode node)
String	getOptionUri()
boolean	isOption(Map<String,String> prefixes, org.z3950.zing.cql.CQLNode node)
boolean	isOption(Map<String,String> prefixes, String option)
String	prefixFromOption(org.z3950.zing.cql.CQLNode node)
String	prefixFromOption(String option)
eu.dnetlib.functionality.index.query.Pruner.Result	prune(org.z3950.zing.cql.CQLNode root) Remove all options from a given CQL AST and return all the options.
eu.dnetlib.functionality.index.query.Pruner.Result	prune(Map<String,String> prefixes, org.z3950.zing.cql.CQLBooleanNode node) boolean prunes are handled in the prune(prefix, node, left, right).
eu.dnetlib.functionality.index.query.Pruner.Result	prune(Map<String,String> prefixes, org.z3950.zing.cql.CQLBooleanNode bool, org.z3950.zing.cql.CQLNode left, org.z3950.zing.cql.CQLNode right) Detects if a left or right side of a boolean node is a option term, and returns the other side (recursively pruned).
eu.dnetlib.functionality.index.query.Pruner.Result	prune(Map<String,String> prefixes, org.z3950.zing.cql.CQLNode root) Actual recursive implementation, dispatches the implementation to the appropriate overloaded method.
eu.dnetlib.functionality.index.query.Pruner.Result	prune(Map<String,String> prefixes, org.z3950.zing.cql.CQLPrefixNode node) If the current node is a cql "prefix" node, add his namespace declaration to the current list of namespaces and return the pruned inner subtree.
eu.dnetlib.functionality.index.query.Pruner.Result	prune(Map<String,String> prefixes, org.z3950.zing.cql.CQLSortNode node) If the current node is a cql "sort" node, just return the inner subtree.
void	setOptionUri(String optionUri)
eu.dnetlib.functionality.index.query.Pruner.Result	trimOption(Map<String,String> prefixes, org.z3950.zing.cql.CQLNode a, org.z3950.zing.cql.CQLNode b) Trims an option from a boolean node if one if it's sides is an option term.
eu.dnetlib.functionality.index.query.Pruner.Result	trimOption(Map<String,String> prefixes, String ns, String o, org.z3950.zing.cql.CQLNode subtree) prune(prefixes, bool, left, right) uses this helper method to do the dirty job: we have to detect if a term node is a term option node.

Methods inherited from class java.lang.Object

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

Field Detail

DNET_URI

public static final String DNET_URI

All options have to be in this namespace.

See Also:

Constant Field Values

Constructor Detail

Pruner

public Pruner()

Method Detail

prune

public eu.dnetlib.functionality.index.query.Pruner.Result prune(org.z3950.zing.cql.CQLNode root)

Remove all options from a given CQL AST and return all the options. The CQL tree is modified.

Parameters:

root - cql tree

Returns:

pair containing a new root node and a list of options

prune

public eu.dnetlib.functionality.index.query.Pruner.Result prune(Map<String,String> prefixes,
                                                                org.z3950.zing.cql.CQLNode root)

Actual recursive implementation, dispatches the implementation to the appropriate overloaded method.

Parameters:

prefixes -

root -

Returns:

the pruned result

prune

public eu.dnetlib.functionality.index.query.Pruner.Result prune(Map<String,String> prefixes,
                                                                org.z3950.zing.cql.CQLSortNode node)

If the current node is a cql "sort" node, just return the inner subtree.

Parameters:

prefixes -

node -

Returns:

the pruned result

prune

public eu.dnetlib.functionality.index.query.Pruner.Result prune(Map<String,String> prefixes,
                                                                org.z3950.zing.cql.CQLPrefixNode node)

If the current node is a cql "prefix" node, add his namespace declaration to the current list of namespaces and return the pruned inner subtree. If the prefix node contains only one single option element, we have to return null. (TODO: perhaps there is a better solution).

Parameters:

prefixes -

node -

Returns:

the pruned result

prune

public eu.dnetlib.functionality.index.query.Pruner.Result prune(Map<String,String> prefixes,
                                                                org.z3950.zing.cql.CQLBooleanNode node)

boolean prunes are handled in the prune(prefix, node, left, right).

Parameters:

prefixes -

node -

Returns:

the pruned result

prune

public eu.dnetlib.functionality.index.query.Pruner.Result prune(Map<String,String> prefixes,
                                                                org.z3950.zing.cql.CQLBooleanNode bool,
                                                                org.z3950.zing.cql.CQLNode left,
                                                                org.z3950.zing.cql.CQLNode right)

Detects if a left or right side of a boolean node is a option term, and returns the other side (recursively pruned). It also returns the accumulated options along the way.

Parameters:

prefixes -

bool -

left -

right -

Returns:

the pruned result

anyNotNull

public <T> T anyNotNull(T a,
                        T b)

trimOption

public eu.dnetlib.functionality.index.query.Pruner.Result trimOption(Map<String,String> prefixes,
                                                                     org.z3950.zing.cql.CQLNode a,
                                                                     org.z3950.zing.cql.CQLNode b)

Trims an option from a boolean node if one if it's sides is an option term. Intended to be used once for each sides and then swap.

Parameters:

prefixes -

a -

b -

Returns:

the pruned result

trimOption

public eu.dnetlib.functionality.index.query.Pruner.Result trimOption(Map<String,String> prefixes,
                                                                     String ns,
                                                                     String o,
                                                                     org.z3950.zing.cql.CQLNode subtree)

prune(prefixes, bool, left, right) uses this helper method to do the dirty job: we have to detect if a term node is a term option node. by checking the namespace uri associated with the term prefix according the the current namespace prefix scope (held in prefixes, which is passed down recursively by copy).

Parameters:

prefixes -

ns -

o -

subtree -

Returns:

the pruned result

getOption

public String getOption(org.z3950.zing.cql.CQLNode node)

prefixFromOption

public String prefixFromOption(String option)

prefixFromOption

public String prefixFromOption(org.z3950.zing.cql.CQLNode node)

isOption

public boolean isOption(Map<String,String> prefixes,
                        String option)

isOption

public boolean isOption(Map<String,String> prefixes,
                        org.z3950.zing.cql.CQLNode node)

getOptionUri

public String getOptionUri()

setOptionUri

public void setOptionUri(String optionUri)