com.eibus.xml.nom

Class Find

java.lang.Object

com.eibus.xml.nom.Find

Deprecated.

, recommended to use methods of com.eibus.xml.xpath.XPath class which are standard XPath1.0 compliant. Two methods listCompare() and node() have been moved to com.eibus.xml.nom.Node class. Method node() is renamed to isValidNode(int supposedNode). Find contains a number of static methods that you can use to search an XML tree. A description of the contents of the various search patterns can be found in XML Search Patterns.

public class Find
extends java.lang.Object

See Also:

FindHandler

Method Summary

Modifier and Type	Method and Description
static java.lang.String[]	data(int node, java.lang.String pattern) Deprecated. Returns all data of the the first node that matches the pattern.
static int	first(int node, java.lang.String criteria) Deprecated. Retrieves the first node that matches the criteria
static java.lang.String	firstData(int node, java.lang.String pattern, java.lang.String defaultValue) Deprecated. Since BCP 4.2, it is recommended to use firstDataWithDefault Returns all data of the the first node that matches the pattern.
static java.lang.String	firstDataWithDefault(int node, java.lang.String pattern, java.lang.String defaultValue) Deprecated. Returns all data of the the first node that matches the pattern.
static int	firstElement(int node, java.lang.String pattern) Deprecated. Returns the first element child of the first node that matches the pattern.
static int[]	firstElements(int node, java.lang.String pattern) Deprecated. Returns the first element children of the nodes that match the pattern.
static int	firstInList(int from, int to, java.lang.String criteria) Deprecated. Retrieves the first node in the list of nodes that matches the criteria
static int	firstMatch(int node, java.lang.String pattern) Deprecated. Returns the first node that matches the pattern
static int	firstMatchInList(int from, int to, java.lang.String pattern) Deprecated. Returns the first node that matches the pattern
static int	listCompare(int from1, int to1, int from2, int to2, int depth, int flags) Deprecated. Use listCompare() method of com.eibus.xml.nom.Node class.
static int[]	match(int node, java.lang.String pattern) Deprecated. Returns a list of xml nodes that match the pattern, as an int array of handles of the matching nodes.
static void	match(int node, java.lang.String pattern, FindHandler handler) Deprecated. Performs a match operation based on the specified pattern and calls the handler for each node that matches the pattern.
static int	matchInList(int from, int to, java.lang.String pattern) Deprecated. Returns a list of xml nodes that match the pattern in the given range of nodes.
static boolean	node(int supposedNode) Deprecated. Use isValidNode() method of com.eibus.xml.nom.Node class.
static int	nodes(int node, java.lang.String criteria, int maxFound, int[] numFound) Deprecated.
static int	setOfSiblingNodes(int node, java.lang.String criteria, int maxFound, int[] numFound) Deprecated.

Methods inherited from class java.lang.Object

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

Method Detail

first

public static int first(int node,
                        java.lang.String criteria)

Deprecated.

Retrieves the first node that matches the criteria

Parameters:

node - int reference of the node

criteria - specify name of the node that should be found

firstInList

public static int firstInList(int from,
                              int to,
                              java.lang.String criteria)

Deprecated.

Retrieves the first node in the list of nodes that matches the criteria

Parameters:

from - int reference of the node

to - until which node

criteria - specify name of the node that should be found

Returns:

The node that matches, or 0 if no match is found.

firstMatch

public static int firstMatch(int node,
                             java.lang.String pattern)

Deprecated.

Returns the first node that matches the pattern

Parameters:

node - The node to start searching in.

pattern - The pattern to match.

Returns:

The node that matches, or 0 if no match is found.

firstData

public static java.lang.String firstData(int node,
                                         java.lang.String pattern,
                                         java.lang.String defaultValue)

Deprecated.

Since BCP 4.2, it is recommended to use firstDataWithDefault Returns all data of the the first node that matches the pattern. Internally, this calls Find.firstMatch and consequently Node.getData(). Notice that Node.getData() will return a concatenation of the String values of all child nodes of type data if the node on which it is called is of type element.

Parameters:

node - The node to start searching in.

pattern - The pattern to match.

defaultValue - The default value to return if no matching node was found

Returns:

The node that matches, or 0 if no match was found.

See Also:

Find.firstDataWithDefault

firstDataWithDefault

public static java.lang.String firstDataWithDefault(int node,
                                                    java.lang.String pattern,
                                                    java.lang.String defaultValue)

Deprecated.

Returns all data of the the first node that matches the pattern. Internally, this calls Find.firstMatch and consequently Node.getDataWithDefault(). Notice that Node.getDataWithDefault() will return a concatenation of the String values of all child nodes of type data if the node on which it is called is of type element.

Parameters:

node - The node to start searching in.

pattern - The pattern to match.

defaultValue - The default value to return if no matching node was found

Returns:

The data of node(s) if the given pattern matches a node; otherwise, the given default value.

firstElement

public static int firstElement(int node,
                               java.lang.String pattern)

Deprecated.

Returns the first element child of the first node that matches the pattern. This function can be used instead of a pattern ending with 'fChild', since fChild can also return nodes of type data.

Parameters:

node - The node to start searching in.

pattern - The pattern to match.

Returns:

The first element child of the node that matches, or 0 if no match was found.

data

public static java.lang.String[] data(int node,
                                      java.lang.String pattern)

Deprecated.

Returns all data of the the first node that matches the pattern. Internally, this calls Find.match and consequently Node.getData() on each of the resulting nodes. Notice that Node.getData() will return a concatenation of the String values of all child nodes of type data if the node on which it is called is of type element.

Parameters:

node - The node to start searching in.

pattern - The pattern to match.

Returns:

The node that matches, or 0 if no match was found.

firstElements

public static int[] firstElements(int node,
                                  java.lang.String pattern)

Deprecated.

Returns the first element children of the nodes that match the pattern. Basically, this calls Find.match, and on each of the resulting nodes, Node.getFirstElement is called. This function can be used instead of a pattern that ends with 'fChild', since 'fChild' may also result in a node of type data.

Parameters:

node - The node to start searching in.

pattern - The pattern to match.

Returns:

An array of nodes.

firstMatchInList

public static int firstMatchInList(int from,
                                   int to,
                                   java.lang.String pattern)

Deprecated.

Returns the first node that matches the pattern

Parameters:

from - The node to start searching in.

to - The last node to search in.

pattern - The pattern to match.

Returns:

The node that matches, or 0 if no match was found.

match

public static int[] match(int node,
                          java.lang.String pattern)

Deprecated.

Returns a list of xml nodes that match the pattern, as an int array of handles of the matching nodes.

Parameters:

node - The node to start the search in.

pattern - The match-pattern

Returns:

an array of handles to the matching nodes.

matchInList

public static int matchInList(int from,
                              int to,
                              java.lang.String pattern)

Deprecated.

Returns a list of xml nodes that match the pattern in the given range of nodes. The list is wrapped in an XML node that has a number of child nodes of type element. Each child has a data child that contains a String representing an integer that can be used as a node pointer.

Parameters:

from - The node to start the search.

to - The node to end the search.

pattern - The match-pattern

Returns:

An XML node containing the search results.

listCompare

public static int listCompare(int from1,
                              int to1,
                              int from2,
                              int to2,
                              int depth,
                              int flags)

Deprecated.

Use listCompare() method of com.eibus.xml.nom.Node class. Compares two lists of XML nodes for equality.

Parameters:

from1 - the start reference of the first set of nodes

to1 - the end reference of the first set of nodes

from2 - the start reference of the second set of nodes

to2 - the end reference of the second set of nodes

depth - depth until which to compare

flags - This specifies the behavior of the comparison
Specify 0 to compare both attributes and values of the specified node.
Specify 1 to exclude data from comparison.
Specify 2 to exclude attributes from comparison.
Specify 8 to check logical equivalence, i.e, comparison based on URIs, not on prefixes.
Specify 128 for SemanticalIn operation.
Specifiy 256 for SemanticalEqual operation.

Returns:

Returns 0, if the XML nodes are matched.
Returns 1, if the XML nodes do not match.

nodes

public static int nodes(int node,
                        java.lang.String criteria,
                        int maxFound,
                        int[] numFound)

Deprecated.

setOfSiblingNodes

public static int setOfSiblingNodes(int node,
                                    java.lang.String criteria,
                                    int maxFound,
                                    int[] numFound)

Deprecated.

node

public static boolean node(int supposedNode)

Deprecated.

Use isValidNode() method of com.eibus.xml.nom.Node class. Determines whether the supposed node is a node or not.

match

public static void match(int node,
                         java.lang.String pattern,
                         FindHandler handler)

Deprecated.

Performs a match operation based on the specified pattern and calls the handler for each node that matches the pattern.

Parameters:

node - The root to start searching in.

pattern - The match pattern.

handler - The call back object