net.sf.saxon

Class AugmentedSource

public class AugmentedSource extends Object implements Source

This class is an extension of the JAXP Source interface. The class can be used wherever a JAXP Source object can be used, and it provides additional information about the way that the Source is to be processed: for example, it indicates whether or not it should be validated against a schema. Other options that can be set include the SAX XMLReader to be used, and the choice of whether a source in the form of an existing tree should be copied or wrapped.

Since: 8.8

Method Summary
voidaddFilter(ProxyReceiver filter)
Add a filter to the list of filters to be applied to the raw input
voidclose()
Close any resources held by this Source.
SourcegetContainedSource()
Get the Source object wrapped by this AugmentedSource
intgetDTDValidation()
Get whether or not DTD validation of this source is required
EntityResolvergetEntityResolver()
Get the EntityResolver that will be used when parsing
ErrorListenergetErrorListener()
Get the ErrorListener that will be used when parsing
ListgetFilters()
Get the list of filters to be applied to the input.
TreeModelgetModel()
Get the tree model that will be used.
ParseOptionsgetParseOptions()
Get the ParseOptions defined in this AugmentedSource
intgetSchemaValidation()
Get whether or not schema validation of this source is required
intgetStripSpace()
Get the space-stripping action to be applied to the source document
StringgetSystemId()
Get the System ID.
StructuredQNamegetTopLevelElement()
Get the name of the top-level element for validation.
SchemaTypegetTopLevelType()
Get the type of the document element for validation.
intgetTreeModel()
Get the tree model that will be used.
BooleangetWrapDocument()
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.
XMLReadergetXMLReader()
Get the SAX parser (XMLReader) to be used
booleanisLineNumbering()
Get whether line numbers are to be maintained in the constructed document
booleanisLineNumberingSet()
Determine whether setLineNumbering() has been called
booleanisPleaseCloseAfterUse()
Determine whether or not the user of this Source is encouraged to close it as soon as reading is finished.
booleanisXIncludeAware()

Get state of XInclude processing.

booleanisXIncludeAwareSet()

Determine whether setXIncludeAware() has been called.

static AugmentedSourcemakeAugmentedSource(Source source)
Create an AugmentedSource that wraps a given Source object.
voidsetDTDValidationMode(int option)
Set whether or not DTD validation of this source is required
voidsetEntityResolver(EntityResolver resolver)
Set an EntityResolver to be used when parsing.
voidsetErrorListener(ErrorListener listener)
Set an ErrorListener to be used when parsing
voidsetLineNumbering(boolean lineNumbering)
Set whether line numbers are to be maintained in the constructed document
voidsetModel(TreeModel model)
Set the tree model to use.
voidsetPleaseCloseAfterUse(boolean close)
Set whether or not the user of this Source is encouraged to close it as soon as reading is finished.
voidsetSchemaValidationMode(int option)
Set whether or not schema validation of this source is required
voidsetStripSpace(int stripAction)
Set the space-stripping action to be applied to the source document
voidsetSystemId(String id)
Set the System ID.
voidsetTopLevelElement(StructuredQName elementName)
Set the name of the top-level element for validation.
voidsetTopLevelType(SchemaType type)
Set the type of the top-level element for validation.
voidsetTreeModel(int model)
Set the tree model to use.
voidsetWrapDocument(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.
voidsetXIncludeAware(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 false.

voidsetXMLReader(XMLReader parser)
Set the SAX parser (XMLReader) to be used

Method Detail

addFilter

public void addFilter(ProxyReceiver filter)
Add a filter to the list of filters to be applied to the raw input

Parameters: filter the filter to be added

close

public void close()
Close any resources held by this Source. This only works if the underlying Source is one that is recognized as holding closable resources.

Since: 8.8

getContainedSource

public Source getContainedSource()
Get the Source object wrapped by this AugmentedSource

Returns: the contained Source object

Since: 8.8

getDTDValidation

public int getDTDValidation()
Get whether or not DTD validation of this source is required

Returns: the validation mode requested, or DEFAULT to use the default validation mode from the Configuration.

Since: 8.8

getEntityResolver

public EntityResolver getEntityResolver()
Get the EntityResolver that will be used when parsing

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.

getErrorListener

public ErrorListener getErrorListener()
Get the ErrorListener that will be used when parsing

Returns: the ErrorListener, if one has been set using AugmentedSource, otherwise null.

Since: 8.9

getFilters

public List getFilters()
Get the list of filters to be applied to the input. Returns null if there are no filters.

Returns: the list of filters, if there are any

getModel

public TreeModel getModel()
Get the tree model that will be used.

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

getParseOptions

public ParseOptions getParseOptions()
Get the ParseOptions defined in this AugmentedSource

Returns: the ParseOptions, a bundle of options equivalent to obtaining all the properties individually

getSchemaValidation

public int getSchemaValidation()
Get whether or not schema validation of this source is required

Returns: the validation mode requested, or DEFAULT to use the default validation mode from the Configuration.

Since: 8.8

getStripSpace

public int getStripSpace()
Get the space-stripping action to be applied to the source document

Returns: one of IGNORABLE, ALL, or NONE

Since: 8.8

getSystemId

public String getSystemId()
Get the System ID. This gets the System Id on the underlying Source object.

Returns: the System ID: effectively the base URI.

Since: 8.8

getTopLevelElement

public StructuredQName getTopLevelElement()
Get the name of the top-level element for validation. If a top-level element is set then the document being validated must have this as its outermost element

Returns: the QName of the required top-level element, or null if no value is set

Since: 9.0

getTopLevelType

public SchemaType getTopLevelType()
Get the type of the document element for validation. If this is set then the document element of the document being validated must have this type

Returns: the type of the required top-level element, or null if no value is set

Since: 9.0

getTreeModel

public int getTreeModel()

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)

getWrapDocument

public 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.

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

getXMLReader

public XMLReader getXMLReader()
Get the SAX parser (XMLReader) to be used

Returns: the parser

Since: 8.8

isLineNumbering

public boolean isLineNumbering()
Get whether line numbers are to be maintained in the constructed document

Returns: true if line numbers are maintained

Since: 8.8

isLineNumberingSet

public boolean isLineNumberingSet()
Determine whether setLineNumbering() has been called

Returns: true if setLineNumbering() has been called

Since: 8.9

isPleaseCloseAfterUse

public boolean isPleaseCloseAfterUse()
Determine whether or not the user of this Source is encouraged to close it as soon as reading is finished.

Returns: true if the source should be closed as soon as it has been consumed

Since: 8.8

isXIncludeAware

public boolean isXIncludeAware()

Get state of XInclude processing.

Returns: current state of XInclude processing. Default value is false.

Since: 8.9

isXIncludeAwareSet

public boolean isXIncludeAwareSet()

Determine whether setXIncludeAware() has been called.

Returns: true if setXIncludeAware() has been called

Since: 8.9

makeAugmentedSource

public static AugmentedSource makeAugmentedSource(Source source)
Create an AugmentedSource that wraps a given Source object. If this is already an AugmentedSource, the original AugmentedSource is returned. Note that this means that setting any properties on the returned AugmentedSource will also affect the original.

Parameters: source the Source object to be wrapped

Returns: an AugmentedSource

Since: 8.8

setDTDValidationMode

public void setDTDValidationMode(int option)
Set whether or not DTD validation of this source is required

Parameters: option one of STRICT, STRIP, DEFAULT

Since: 8.8

setEntityResolver

public void setEntityResolver(EntityResolver resolver)
Set an EntityResolver to be used when parsing. Note this is used only when a system-allocated parser is used; when a user-supplied parser is used (for example in a SAXSource), the EntityResolver should be preinitialized.

Parameters: resolver the EntityResolver to be used

Since: 8.9. The method had no useful effect in releases prior to 9.2.

setErrorListener

public void setErrorListener(ErrorListener listener)
Set an ErrorListener to be used when parsing

Parameters: listener the ErrorListener to be used

Since: 8.9

setLineNumbering

public void setLineNumbering(boolean lineNumbering)
Set whether line numbers are to be maintained in the constructed document

Parameters: lineNumbering true if line numbers are to be maintained

Since: 8.8

setModel

public void setModel(TreeModel model)
Set the tree model to use. Default is the tiny tree

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

setPleaseCloseAfterUse

public void setPleaseCloseAfterUse(boolean close)
Set whether or not the user of this Source is encouraged to close it as soon as reading is finished. Normally the expectation is that any Stream in a StreamSource will be closed by the component that created the Stream. However, in the case of a Source returned by a URIResolver, there is no suitable interface (the URIResolver has no opportunity to close the stream). Also, in some cases such as reading of stylesheet modules, it is possible to close the stream long before control is returned to the caller who supplied it. This tends to make a difference on .NET, where a file often can't be opened if there is a stream attached to it.

Parameters: close true if the source should be closed as soon as it has been consumed

Since: 8.8

setSchemaValidationMode

public void setSchemaValidationMode(int option)
Set whether or not schema validation of this source is required

Parameters: option one of STRICT, LAX, STRIP, PRESERVE, DEFAULT

Since: 8.8

setStripSpace

public void setStripSpace(int stripAction)
Set the space-stripping action to be applied to the source document

Parameters: stripAction one of IGNORABLE, ALL, or NONE

Since: 8.8

setSystemId

public void setSystemId(String id)
Set the System ID. This sets the System Id on the underlying Source object.

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

setTopLevelElement

public void setTopLevelElement(StructuredQName elementName)
Set the name of the top-level element for validation. If a top-level element is set then the document being validated must have this as its outermost element

Parameters: elementName the QName of the required top-level element, or null to unset the value

Since: 9.0

setTopLevelType

public void setTopLevelType(SchemaType type)
Set the type of the top-level element for validation. If this is set then the document element is validated against this type

Parameters: type the schema type required for the document element, or null to unset the value

Since: 9.0

setTreeModel

public void setTreeModel(int model)

Deprecated: since 9.2: use AugmentedSource

Set the tree model to use. Default is the tiny tree

Parameters: model one of TINY_TREE, TINY_TREE_CONDENSED or LINKED_TREE

Since: 8.9 (Condensed tree added in 9.2)

setWrapDocument

public 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.

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

setXIncludeAware

public 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 false.

Parameters: state Set XInclude processing to true or false

Since: 8.9

setXMLReader

public void setXMLReader(XMLReader parser)
Set the SAX parser (XMLReader) to be used

Parameters: parser the SAX parser

Since: 8.8