|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.sxpath.AbstractStaticContext net.sf.saxon.sxpath.IndependentContext
public class IndependentContext
An IndependentContext provides a context for parsing an XPath expression appearing in a context other than a stylesheet.
This class is used in a number of places where freestanding XPath expressions occur. These include the native Saxon XPath API, the .NET XPath API, XPath expressions used in XML Schema identity constraints, and XPath expressions supplied to saxon:evaluate(). It is not used by the JAXP XPath API (though it shares code with that API through the common superclass AbstractStaticContext).
This class currently provides no mechanism for binding user-defined functions.
Field Summary | |
---|---|
protected boolean |
autoDeclare
|
protected NamespaceResolver |
externalResolver
|
protected Set |
importedSchemaNamespaces
|
protected HashMap<String,String> |
namespaces
|
protected ItemType |
requiredContextItemType
|
protected HashMap<StructuredQName,XPathVariable> |
variables
|
Fields inherited from class net.sf.saxon.sxpath.AbstractStaticContext |
---|
usingDefaultFunctionLibrary |
Constructor Summary | |
---|---|
IndependentContext()
Create an IndependentContext along with a new (non-schema-aware) Saxon Configuration |
|
IndependentContext(Configuration config)
Create an IndependentContext using a specific Configuration |
Method Summary | |
---|---|
Expression |
bindVariable(StructuredQName qName)
Bind a variable used in an XPath Expression to the XSLVariable element in which it is declared. |
void |
clearAllNamespaces()
Clear all the declared namespaces, including the standard ones (xml, xslt, saxon). |
void |
clearNamespaces()
Clear all the declared namespaces, except for the standard ones (xml, xslt, saxon, xdt). |
void |
declareNamespace(String prefix,
String uri)
Declare a namespace whose prefix can be used in expressions |
XPathVariable |
declareVariable(QNameValue qname)
Declare a variable. |
XPathVariable |
declareVariable(String namespaceURI,
String localName)
Declare a variable. |
XPathVariable |
declareVariable(StructuredQName qName)
Declare a variable. |
int |
getContainerGranularity()
Get the granularity of the container. |
XPathVariable |
getExternalVariable(StructuredQName qName)
Get the declared variable with a given name, if there is one |
Set<String> |
getImportedSchemaNamespaces()
Get the set of imported schemas |
NamespaceResolver |
getNamespaceResolver()
Get a namespace resolver to resolve the namespaces declared in this static context. |
ItemType |
getRequiredContextItemType()
Get the required type of the context item. |
int |
getSlotNumber(QNameValue qname)
Get the slot number allocated to a particular variable |
SlotManager |
getStackFrameMap()
Get a Stack Frame Map containing definitions of all the declared variables. |
String |
getURIForPrefix(String prefix)
Get the URI for a prefix, using the declared namespaces as the context for namespace resolution. |
String |
getURIForPrefix(String prefix,
boolean useDefault)
Get the namespace URI corresponding to a given prefix. |
boolean |
isAllowUndeclaredVariables()
Ask whether undeclared variables are allowed. |
boolean |
isImportedSchema(String namespace)
Ask whether a Schema for a given target namespace has been imported. |
Iterator<XPathVariable> |
iterateExternalVariables()
Get an iterator over all the variables that have been declared, either explicitly by an application call on declareVariable(), or implicitly if the option allowUndeclaredVariables
is set. |
Iterator |
iteratePrefixes()
Get an iterator over all the prefixes declared in this namespace context. |
void |
setAllowUndeclaredVariables(boolean allow)
Say whether undeclared variables are allowed. |
void |
setDefaultElementNamespace(String uri)
Set the default namespace for elements and types |
void |
setImportedSchemaNamespaces(Set namespaces)
Register the set of imported schema namespaces |
void |
setNamespaceResolver(NamespaceResolver resolver)
Set an external namespace resolver. |
void |
setNamespaces(NodeInfo node)
Declares all the namespaces that are in-scope for a given node, removing all previous namespace declarations. |
void |
setRequiredContextItemType(ItemType type)
Declare the static type of the context item. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface net.sf.saxon.expr.StaticContext |
---|
getBaseURI, getCollation, getConfiguration, getDecimalFormatManager, getDefaultCollationName, getDefaultElementNamespace, getDefaultFunctionNamespace, getFunctionLibrary, getLineNumber, getLocationMap, getNamePool, getSystemId, getXPathLanguageLevel, isAllowedBuiltInType, isInBackwardsCompatibleMode, isSchemaAware, issueWarning, makeEarlyEvaluationContext |
Field Detail |
---|
protected HashMap<String,String> namespaces
protected HashMap<StructuredQName,XPathVariable> variables
protected NamespaceResolver externalResolver
protected ItemType requiredContextItemType
protected Set importedSchemaNamespaces
protected boolean autoDeclare
Constructor Detail |
---|
public IndependentContext()
public IndependentContext(Configuration config)
config
- the Saxon configuration to be usedMethod Detail |
---|
public int getContainerGranularity()
public void declareNamespace(String prefix, String uri)
prefix
- The namespace prefix. Must not be null. Supplying "" sets the
default element namespace.uri
- The namespace URI. Must not be null.public void setDefaultElementNamespace(String uri)
setDefaultElementNamespace
in interface XPathStaticContext
setDefaultElementNamespace
in class AbstractStaticContext
uri
- the namespace to be used for unprefixed element and type names.
The value "" (or NamespaceConstant.NULL) represents the non-namespacepublic void clearNamespaces()
public void clearAllNamespaces()
public void setNamespaces(NodeInfo node)
node
- The node whose in-scope namespaces are to be used as the context namespaces.
If the node is an attribute, text node, etc, then the namespaces of its parent element are used.public void setNamespaceResolver(NamespaceResolver resolver)
setNamespaceResolver
in interface XPathStaticContext
resolver
- the external NamespaceResolverpublic void setAllowUndeclaredVariables(boolean allow)
allow
- true if undeclared variables are allowed, false if they are not allowed.public boolean isAllowUndeclaredVariables()
public XPathVariable declareVariable(QNameValue qname)
declareVariable
in interface XPathStaticContext
qname
- The name of the variable
public XPathVariable declareVariable(String namespaceURI, String localName)
declareVariable
in interface XPathStaticContext
namespaceURI
- The namespace URI of the name of the variable. Supply "" to represent
names in no namespace (null is also accepted)localName
- The local part of the name of the variable (an NCName)
public XPathVariable declareVariable(StructuredQName qName)
qName
- the name of the variable.
public Iterator<XPathVariable> iterateExternalVariables()
allowUndeclaredVariables
is set.
public XPathVariable getExternalVariable(StructuredQName qName)
qName
- the name of the required variable
public int getSlotNumber(QNameValue qname)
qname
- the name of the variable
public String getURIForPrefix(String prefix) throws XPathException
getURIForPrefix
in interface StaticContext
prefix
- The prefix
XPathException
- if the prefix is not declared; the
associated error code should be XPST0081public NamespaceResolver getNamespaceResolver()
StaticContext
getNamespaceResolver
in interface StaticContext
public String getURIForPrefix(String prefix, boolean useDefault)
getURIForPrefix
in interface NamespaceResolver
prefix
- the namespace prefixuseDefault
- true if the default namespace is to be used when the
prefix is ""
public Iterator iteratePrefixes()
iteratePrefixes
in interface NamespaceResolver
public Expression bindVariable(StructuredQName qName) throws XPathException
bindVariable
in interface StaticContext
qName
- the name of the variable
XPathException
public SlotManager getStackFrameMap()
getStackFrameMap
in interface XPathStaticContext
public boolean isImportedSchema(String namespace)
StaticContext
isImportedSchema
in interface StaticContext
namespace
- the target namespace in question
public Set<String> getImportedSchemaNamespaces()
getImportedSchemaNamespaces
in interface StaticContext
public void setImportedSchemaNamespaces(Set namespaces)
namespaces
- the set of namespaces for which schema components are available in the
static contextpublic void setRequiredContextItemType(ItemType type)
type
- the required type of the context itempublic ItemType getRequiredContextItemType()
getRequiredContextItemType
in interface StaticContext
getRequiredContextItemType
in class AbstractStaticContext
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |