Package com.orchestranetworks.schema
Class Step
- java.lang.Object
-
- com.orchestranetworks.schema.Step
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract String
format()
Returns the string representation of this step.abstract int
getIndex()
ReturnsStep
index.abstract boolean
isIndexed()
Returnstrue
if thisStep
identifies a node child by its position.boolean
isRelative()
Returnstrue
if this instance is either self or parent step ('.' or '..').boolean
isRelativeParent()
Returnstrue
if this instance is the parent step ('..').boolean
isRelativeSelf()
Returnstrue
if this instance is the self step (.
).static Step
parse(String aString)
Returns the step corresponding to theString
specified.Path
toAbsolutePath()
Returns the absolute path whose unique step is this instance.Path
toParentPath()
Returns the relative path whose first step is '..' (parent step) and the second step is this instance.Path
toSelfPath()
Returns the relative path whose first step is '.' (self step) and the second step is this instance.Step
toStepWithoutIndex()
-
-
-
Method Detail
-
parse
public static Step parse(String aString) throws IllegalArgumentException
Returns the step corresponding to theString
specified.- Throws:
IllegalArgumentException
- If step syntax is not correct.- See Also:
format()
-
format
public abstract String format()
Returns the string representation of this step.- See Also:
Path.format()
-
isIndexed
public abstract boolean isIndexed()
Returnstrue
if thisStep
identifies a node child by its position. The first position is 0 (in XPath, the first position is 1). For example, in the pathpara/item[0]/label
,item[0]
is an indexed step identifying position 0.Regarding JavaBeans, an instance of this class corresponds to an indexed property.
- See Also:
getIndex()
-
getIndex
public abstract int getIndex()
ReturnsStep
index.Index starts at 0.
- Throws:
IllegalStateException
- IfStep
is not indexed.- See Also:
toStepWithoutIndex()
,isIndexed()
-
toStepWithoutIndex
public Step toStepWithoutIndex()
- Throws:
IllegalStateException
- IfStep
is not indexed.- See Also:
isIndexed()
-
toAbsolutePath
public Path toAbsolutePath()
Returns the absolute path whose unique step is this instance.
-
toSelfPath
public Path toSelfPath()
Returns the relative path whose first step is '.' (self step) and the second step is this instance.
-
toParentPath
public Path toParentPath()
Returns the relative path whose first step is '..' (parent step) and the second step is this instance.
-
isRelative
public final boolean isRelative()
Returnstrue
if this instance is either self or parent step ('.' or '..').
-
isRelativeSelf
public final boolean isRelativeSelf()
Returnstrue
if this instance is the self step (.
).- See Also:
Path.SELF
-
isRelativeParent
public final boolean isRelativeParent()
Returnstrue
if this instance is the parent step ('..').- See Also:
Path.PARENT
-
-