- java.lang.Object
-
- com.sun.xml.xsom.SCD
-
- Direct Known Subclasses:
SCDImpl
public abstract class SCD extends Object
Schema Component Designator (SCD).SCD for schema is what XPath is for XML. SCD allows you to select a schema component(s) from a schema component(s).
See XML Schema: Component Designators. This implementation is based on 03/29/2005 working draft.
- Author:
- Kohsuke Kawaguchi
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
SCD()
Default constructor.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static SCD
create(String path, NamespaceContext nsContext)
Parses the string representation of SCD.Collection<XSComponent>
select(XSComponent contextNode)
Evaluates the SCD against the given context node and returns the matched nodes.Collection<XSComponent>
select(XSSchemaSet contextNode)
Evaluates the SCD against the whole schema and returns the matched nodes.Collection<XSComponent>
select(Collection<? extends XSComponent> contextNodes)
Evaluates the SCD against the given set of context nodes and returns the matched nodes.abstract Iterator<XSComponent>
select(Iterator<? extends XSComponent> contextNodes)
Evaluates the SCD against the given set of context nodes and returns the matched nodes.XSComponent
selectSingle(XSComponent contextNode)
Evaluates the SCD against the given context node and returns the matched node.XSComponent
selectSingle(XSSchemaSet contextNode)
Evaluates the SCD against the whole schema set and returns the matched node.abstract String
toString()
Returns the textual SCD representation as given tocreate(String, NamespaceContext)
.
-
-
-
Method Detail
-
create
public static SCD create(String path, NamespaceContext nsContext) throws ParseException
Parses the string representation of SCD.This method involves parsing the path expression and preparing the in-memory structure, so this is useful when you plan to use the same SCD against different context node multiple times.
If you want to evaluate SCD just once, use
XSComponent.select(java.lang.String, javax.xml.namespace.NamespaceContext)
methods.- Parameters:
path
- the string representation of SCD, such as "/foo/bar".nsContext
- ItsNamespaceContext.getNamespaceURI(String)
is used to resolve prefixes in the SCD to the namespace URI.- Throws:
ParseException
-
select
public final Collection<XSComponent> select(XSComponent contextNode)
Evaluates the SCD against the given context node and returns the matched nodes.- Returns:
- could be empty but never be null.
-
select
public final Collection<XSComponent> select(XSSchemaSet contextNode)
Evaluates the SCD against the whole schema and returns the matched nodes.This method is here because
XSSchemaSet
doesn't implementXSComponent
.- Returns:
- could be empty but never be null.
-
selectSingle
public final XSComponent selectSingle(XSComponent contextNode)
Evaluates the SCD against the given context node and returns the matched node.- Returns:
- null if the SCD didn't match anything. If the SCD matched more than one node, the first one will be returned.
-
selectSingle
public final XSComponent selectSingle(XSSchemaSet contextNode)
Evaluates the SCD against the whole schema set and returns the matched node.- Returns:
- null if the SCD didn't match anything. If the SCD matched more than one node, the first one will be returned.
-
select
public abstract Iterator<XSComponent> select(Iterator<? extends XSComponent> contextNodes)
Evaluates the SCD against the given set of context nodes and returns the matched nodes.- Parameters:
contextNodes
-XSComponent
s that represent the context node against which is evaluated.- Returns:
- could be empty but never be null.
-
select
public final Collection<XSComponent> select(Collection<? extends XSComponent> contextNodes)
Evaluates the SCD against the given set of context nodes and returns the matched nodes.- Parameters:
contextNodes
-XSComponent
s that represent the context node against which is evaluated.- Returns:
- could be empty but never be null.
-
toString
public abstract String toString()
Returns the textual SCD representation as given tocreate(String, NamespaceContext)
.
-
-