com.xmlmind.xml.sxpath

Class Path

java.lang.Object

com.xmlmind.xml.sxpath.Path

All Implemented Interfaces:

Serializable

public final class Path
extends Object
implements Serializable

A location path.

A XPath being the union of Paths (that is, Path|Path|...Path), the API of Path is similar to the API of XPath.

See Also:

XPath, Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
static Path	fromString(String s, PrefixToNamespace prefixToNS) Equivalent to fromString(s, prefixToNS, false).
static Path	fromString(String s, PrefixToNamespace prefixToNS, boolean allowDefaultNS) Parses specified string as a Path.
Step[]	getSteps() Returns the sequence of location steps composing this path.
boolean	isAbsolute() Returns true if this path is absolute (that is, it begins with /).
boolean	isSelectingAttributes() Returns true if this path can be used to select attributes (that is, it ends with /@attribute-name).
boolean	match(XNode xnode)
XNode[]	select(Tree tree)
XNode[]	select(Tree tree, boolean attributePlaceholder)
String	toString(NamespaceToPrefixes nsToPrefixes) Returns this Path converted to a parsable string.
void	toString(StringBuilder buffer, NamespaceToPrefixes nsToPrefixes) Formats this Path as a parsable string.

Methods inherited from class java.lang.Object

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

Method Detail

fromString

public static Path fromString(String s,
                              PrefixToNamespace prefixToNS)

Equivalent to fromString(s, prefixToNS, false).

fromString

public static Path fromString(String s,
                              PrefixToNamespace prefixToNS,
                              boolean allowDefaultNS)

Parses specified string as a Path. Syntax may be abbreviated or not.

Parameters:

s - string to be parsed

prefixToNS - map used to get namespaces corresponding to prefixes found in string; may be null

allowDefaultNS - when parsing an element name having no prefix, use the default namespace if any

Returns:

a Path or null if string has syntax errors or contains unknown prefixes.

See Also:

Name.parse(java.lang.String, boolean, com.xmlmind.xml.name.PrefixToNamespace)

getSteps

public Step[] getSteps()

Returns the sequence of location steps composing this path.

isAbsolute

public boolean isAbsolute()

Returns true if this path is absolute (that is, it begins with /). Returns false otherwise.

isSelectingAttributes

public boolean isSelectingAttributes()

Returns true if this path can be used to select attributes (that is, it ends with /@attribute-name). Returns false otherwise.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString(NamespaceToPrefixes nsToPrefixes)

Returns this Path converted to a parsable string.

Parameters:

nsToPrefixes - map used to get prefixes corresponding to namespaces referenced in this Path; may be null

Returns:

this Path converted to a parsable string

See Also:

Name.format(boolean, com.xmlmind.xml.name.NamespaceToPrefixes)

toString

public void toString(StringBuilder buffer,
                     NamespaceToPrefixes nsToPrefixes)

Formats this Path as a parsable string.

Parameters:

nsToPrefixes - map used to get prefix corresponding to namespace referenced in this Path; may be null

buffer - buffer where formatted string is to be added

See Also:

Name.format(boolean, com.xmlmind.xml.name.NamespaceToPrefixes)

select

public XNode[] select(Tree tree)

select

public XNode[] select(Tree tree,
                      boolean attributePlaceholder)

match

public boolean match(XNode xnode)