Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
net.sf.saxon.AugmentedSource
public class AugmentedSource
extends java.lang.Object
implements Source
Method Summary | |
void |
|
void |
|
Source |
|
int |
|
EntityResolver |
|
ErrorListener |
|
List |
|
int |
|
int |
|
String |
|
StructuredQName |
|
SchemaType |
|
int |
|
Boolean |
|
XMLReader |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
static AugmentedSource |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
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
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
public Source getContainedSource()
Get the Source object wrapped by this AugmentedSource
- Returns:
- the contained Source object
- Since:
- 8.8
public int getDTDValidation()
Get whether or not DTD validation of this source is required
- Returns:
- the validation mode requested, or
Validation.DEFAULT
to use the default validation mode from the Configuration.
- Since:
- 8.8
public EntityResolver getEntityResolver()
Get the EntityResolver that will be used when parsing
- Returns:
- the EntityResolver, if one has been set using
setEntityResolver(EntityResolver)
, otherwise null.
- Since:
- 8.9
public ErrorListener getErrorListener()
Get the ErrorListener that will be used when parsing
- Returns:
- the ErrorListener, if one has been set using
setErrorListener(ErrorListener)
, otherwise null.
- Since:
- 8.9
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
public int getSchemaValidation()
Get whether or not schema validation of this source is required
- Returns:
- the validation mode requested, or
Validation.DEFAULT
to use the default validation mode from the Configuration.
- Since:
- 8.8
public int getStripSpace()
Get the space-stripping action to be applied to the source document
- Returns:
- one of
Whitespace.IGNORABLE
,Whitespace.ALL
, orWhitespace.NONE
- Since:
- 8.8
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
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
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
public int getTreeModel()
Get the tree model that will be used.
- Returns:
- one of
Builder.TINY_TREE
orBuilder.LINKED_TREE
, or {link Builder#UNSPECIFIED_TREE_MODEL} if no call on setTreeModel() has been made
- Since:
- 8.9
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.
- 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
public XMLReader getXMLReader()
Get the SAX parser (XMLReader) to be used
- Returns:
- the parser
- Since:
- 8.8
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
public boolean isLineNumberingSet()
Determine whether setLineNumbering() has been called
- Returns:
- true if setLineNumbering() has been called
- Since:
- 8.9
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
public boolean isXIncludeAware()
Get state of XInclude processing.
- Returns:
- current state of XInclude processing. Default value is false.
- Since:
- 8.9
public boolean isXIncludeAwareSet()
Determine whether setXIncludeAware() has been called.
- Returns:
- true if setXIncludeAware() has been called
- Since:
- 8.9
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
public void setDTDValidationMode(int option)
Set whether or not DTD validation of this source is required
- Parameters:
option
- one ofValidation.STRICT
,Validation.STRIP
,Validation.DEFAULT
- Since:
- 8.8
public void setEntityResolver(EntityResolver resolver)
Set an EntityResolver to be used when parsing
- Parameters:
resolver
- the EntityResolver to be used
- Since:
- 8.9
public void setErrorListener(ErrorListener listener)
Set an ErrorListener to be used when parsing
- Parameters:
listener
- the ErrorListener to be used
- Since:
- 8.9
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
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
public void setSchemaValidationMode(int option)
Set whether or not schema validation of this source is required
- Parameters:
option
- one ofValidation.STRICT
,Validation.LAX
,Validation.STRIP
,Validation.PRESERVE
,Validation.DEFAULT
- Since:
- 8.8
public void setStripSpace(int stripAction)
Set the space-stripping action to be applied to the source document
- Parameters:
stripAction
- one ofWhitespace.IGNORABLE
,Whitespace.ALL
, orWhitespace.NONE
- Since:
- 8.8
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
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
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
public void setTreeModel(int model)
Set the tree model to use. Default is the tiny tree
- Parameters:
model
- one ofBuilder.TINY_TREE
orBuilder.LINKED_TREE
- Since:
- 8.9
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.
- 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
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 tofalse
.
- Parameters:
state
- Set XInclude processing totrue
orfalse
- Since:
- 8.9
public void setXMLReader(XMLReader parser)
Set the SAX parser (XMLReader) to be used
- Parameters:
parser
- the SAX parser
- Since:
- 8.8