net.sf.saxon
public class AugmentedSource extends Object implements Source
Since: 8.8
Method Summary | |
---|---|
void | addFilter(ProxyReceiver filter)
Add a filter to the list of filters to be applied to the raw input |
void | close()
Close any resources held by this Source. |
Source | getContainedSource()
Get the Source object wrapped by this AugmentedSource |
int | getDTDValidation()
Get whether or not DTD validation of this source is required |
EntityResolver | getEntityResolver()
Get the EntityResolver that will be used when parsing |
ErrorListener | getErrorListener()
Get the ErrorListener that will be used when parsing |
List | getFilters()
Get the list of filters to be applied to the input. |
TreeModel | getModel()
Get the tree model that will be used. |
ParseOptions | getParseOptions()
Get the ParseOptions defined in this AugmentedSource |
int | getSchemaValidation()
Get whether or not schema validation of this source is required |
int | getStripSpace()
Get the space-stripping action to be applied to the source document |
String | getSystemId()
Get the System ID. |
StructuredQName | getTopLevelElement()
Get the name of the top-level element for validation.
|
SchemaType | getTopLevelType()
Get the type of the document element for validation.
|
int | getTreeModel()
Get the tree model that will be used. |
Boolean | getWrapDocument()
Assuming that the contained Source is a node in a tree, determine whether a tree will be created
as a view of this supplied tree, or as a copy.
|
XMLReader | getXMLReader()
Get the SAX parser (XMLReader) to be used |
boolean | isLineNumbering()
Get whether line numbers are to be maintained in the constructed document |
boolean | isLineNumberingSet()
Determine whether setLineNumbering() has been called |
boolean | isPleaseCloseAfterUse()
Determine whether or not the user of this Source is encouraged to close it as soon as reading is
finished. |
boolean | isXIncludeAware() Get state of XInclude processing. |
boolean | isXIncludeAwareSet() Determine whether setXIncludeAware() has been called. |
static AugmentedSource | makeAugmentedSource(Source source)
Create an AugmentedSource that wraps a given Source object. |
void | setDTDValidationMode(int option)
Set whether or not DTD validation of this source is required |
void | setEntityResolver(EntityResolver resolver)
Set an EntityResolver to be used when parsing. |
void | setErrorListener(ErrorListener listener)
Set an ErrorListener to be used when parsing |
void | setLineNumbering(boolean lineNumbering)
Set whether line numbers are to be maintained in the constructed document |
void | setModel(TreeModel model)
Set the tree model to use. |
void | setPleaseCloseAfterUse(boolean close)
Set whether or not the user of this Source is encouraged to close it as soon as reading is finished.
|
void | setSchemaValidationMode(int option)
Set whether or not schema validation of this source is required |
void | setStripSpace(int stripAction)
Set the space-stripping action to be applied to the source document |
void | setSystemId(String id)
Set the System ID. |
void | setTopLevelElement(StructuredQName elementName)
Set the name of the top-level element for validation.
|
void | setTopLevelType(SchemaType type)
Set the type of the top-level element for validation.
|
void | setTreeModel(int model)
Set the tree model to use. |
void | setWrapDocument(Boolean wrap)
Assuming that the contained Source is a node in a tree, indicate whether a tree should be created
as a view of this supplied tree, or as a copy.
|
void | setXIncludeAware(boolean state) Set state of XInclude processing. If XInclude markup is found in the document instance, should it be processed as specified in XML Inclusions (XInclude) Version 1.0. XInclude processing defaults to |
void | setXMLReader(XMLReader parser)
Set the SAX parser (XMLReader) to be used |
Parameters: filter the filter to be added
Since: 8.8
Returns: the contained Source object
Since: 8.8
Returns: the validation mode requested, or DEFAULT to use the default validation mode from the Configuration.
Since: 8.8
Returns: the EntityResolver, if one has been set using AugmentedSource, otherwise null.
Since: 8.9 The method had no useful effect in releases prior to 9.2.
Returns: the ErrorListener, if one has been set using AugmentedSource, otherwise null.
Since: 8.9
Returns: the list of filters, if there are any
Returns: typically one of the constants TINY_TREE, TINY_TREE_CONDENSED, or LINKED_TREE. However, in principle a user-defined tree model can be used.
Since: 9.2
Returns: the ParseOptions, a bundle of options equivalent to obtaining all the properties individually
Returns: the validation mode requested, or DEFAULT to use the default validation mode from the Configuration.
Since: 8.8
Returns: one of IGNORABLE, ALL, or NONE
Since: 8.8
Returns: the System ID: effectively the base URI.
Since: 8.8
Returns: the QName of the required top-level element, or null if no value is set
Since: 9.0
Returns: the type of the required top-level element, or null if no value is set
Since: 9.0
Deprecated: since 9.2: use AugmentedSource
Get the tree model that will be used.Returns: one of TINY_TREE, TINY_TREE_CONDENSED, LINKED_TREE, or {link Builder#UNSPECIFIED_TREE_MODEL} if no call on setTreeModel() has been made
Since: 8.9 (Condensed tree added in 9.2)
This option is used only when the Source is supplied to an interface such as the JAXP Transformer.transform() method where there is no other way of indicating whether a supplied external document should be wrapped or copied. It is not used when the Source is supplied to a Saxon-defined interface.
Returns: if true, the node in the supplied Source is wrapped, to create a view. If false, the node and its contained subtree is copied. If null, the system default is chosen.
Since: 8.8
Returns: the parser
Since: 8.8
Returns: true if line numbers are maintained
Since: 8.8
Returns: true if setLineNumbering() has been called
Since: 8.9
Returns: true if the source should be closed as soon as it has been consumed
Since: 8.8
Get state of XInclude processing.
Returns: current state of XInclude processing. Default value is false.
Since: 8.9
Determine whether setXIncludeAware() has been called.
Returns: true if setXIncludeAware() has been called
Since: 8.9
Parameters: source the Source object to be wrapped
Returns: an AugmentedSource
Since: 8.8
Parameters: option one of STRICT, STRIP, DEFAULT
Since: 8.8
Parameters: resolver the EntityResolver to be used
Since: 8.9. The method had no useful effect in releases prior to 9.2.
Parameters: listener the ErrorListener to be used
Since: 8.9
Parameters: lineNumbering true if line numbers are to be maintained
Since: 8.8
Parameters: model typically one of the constants TINY_TREE, TINY_TREE_CONDENSED, or LINKED_TREE. However, in principle a user-defined tree model can be used.
Since: 9.2
Parameters: close true if the source should be closed as soon as it has been consumed
Since: 8.8
Parameters: option one of STRICT, LAX, STRIP, PRESERVE, DEFAULT
Since: 8.8
Parameters: stripAction one of IGNORABLE, ALL, or NONE
Since: 8.8
Parameters: id the System ID. This provides a base URI for the document, and also the result of the document-uri() function
Since: 8.8
Parameters: elementName the QName of the required top-level element, or null to unset the value
Since: 9.0
Parameters: type the schema type required for the document element, or null to unset the value
Since: 9.0
Deprecated: since 9.2: use AugmentedSource
Set the tree model to use. Default is the tiny treeParameters: model one of TINY_TREE, TINY_TREE_CONDENSED or LINKED_TREE
Since: 8.9 (Condensed tree added in 9.2)
This option is used only when the Source is supplied to an interface such as the JAXP Transformer.transform() method where there is no other way of indicating whether a supplied external document should be wrapped or copied. It is not used when the Source is supplied to a Saxon-defined interface.
Parameters: wrap if true, the node in the supplied Source is wrapped, to create a view. If false, the node and its contained subtree is copied. If null, the system default is chosen.
Since: 8.8
Set state of XInclude processing.
If XInclude markup is found in the document instance, should it be processed as specified in XML Inclusions (XInclude) Version 1.0.
XInclude processing defaults to false
.
Parameters: state Set XInclude processing to true
or
false
Since: 8.9
Parameters: parser the SAX parser
Since: 8.8