com.xmlmind.xml.sxpath

Class Step

java.lang.Object

com.xmlmind.xml.sxpath.Step

All Implemented Interfaces:

Serializable

public final class Step
extends Object
implements Serializable

A location step.

A Path is a sequence of Steps. A XPath is the union of one or several Paths (that is, Path|Path ... |Path).

See Also:

Path, XPath, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Step.Axis The axis of this step.
static class	Step.Test The test of this step.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
static Step	fromString(String s, PrefixToNamespace prefixToNS) Equivalent to fromString(s, prefixToNS, false).
static Step	fromString(String s, PrefixToNamespace prefixToNS, boolean allowDefaultNS) Parses specified string as a Step.
Step.Axis	getAxis() Returns the axis of this step.
Step.Test	getTest() Returns the test of this step.
Name	getTestedName() Returns the name tested by this step if test is Step.Test.NAME.
Namespace	getTestedNamespace() Returns the name tested by this step if test is Step.Test.NAMESPACE.
String	toString(NamespaceToPrefixes nsToPrefixes) Returns this Step converted to a parsable string.
void	toString(StringBuilder buffer, NamespaceToPrefixes nsToPrefixes) Formats this Step 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 Step fromString(String s,
                              PrefixToNamespace prefixToNS)

Equivalent to fromString(s, prefixToNS, false).

fromString

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

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

Parameters:

s - string to be parsed

prefixToNS - map used to get namespace corresponding to prefix found in string; may be null

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

Returns:

a Step or null if string has syntax errors or contains an unknown prefix.

See Also:

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

getAxis

public Step.Axis getAxis()

Returns the axis of this step.

getTest

public Step.Test getTest()

Returns the test of this step.

getTestedName

public Name getTestedName()

Returns the name tested by this step if test is Step.Test.NAME. Returns null otherwise.

getTestedNamespace

public Namespace getTestedNamespace()

Returns the name tested by this step if test is Step.Test.NAMESPACE. Returns null otherwise.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString(NamespaceToPrefixes nsToPrefixes)

Returns this Step converted to a parsable string.

Parameters:

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

Returns:

this Step 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 Step as a parsable string.

Parameters:

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

buffer - buffer where formatted string is to be added

See Also:

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