|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
com.icl.saxon.om
Class Builder
java.lang.Object | +--com.icl.saxon.output.Emitter | +--com.icl.saxon.om.Builder
- Direct Known Subclasses:
- TinyBuilder, TreeBuilder
- create a Builder and initialise variables
- Set the root (document) node to use. This method is used to support the JAXP facility to attach transformation output to a supplied Document node. It must be called before startDocument(), and the type of document node must be compatible with the type of Builder used.
- Set timing option on or off
- Get timing option
- Set line numbering on or off
- Set the Stripper to use
- Get the Stripper in use
- Set the PreviewManager to use
- Indicate whether comments and Processing Instructions should be discarded
- Set the SAX error handler to use. If none is specified, SAXON supplies its own, which writes error messages to the selected error output writer.
- Parameters:
eh- The error handler to use. It must conform to the interface
setErrorListener- Set the JAXP error listener to use, if no SAX errorHandler has been provided.
- Parameters:
eh- The error listener to use. It must conform to the interface
setErrorOutput
public void setErrorOutput(java.io.Writer writer)
- Set output for error messages produced by the default error handler.
The default error handler does not throw an exception for parse errors or input I/O errors, rather it returns a result code and writes diagnostics to a user-specified output writer, which defaults to System.err
This call has no effect if setErrorHandler() has been called to supply a user-defined error handler - Parameters:
writer- The Writer to use for error messages
build- Build the tree from an input source. After building the tree, it can be walked as often as required using run(Document doc).
- Parameters:
source- The source to use. SAXSource is a SAX-defined class that allows input from a URL, a byte stream, or a character stream. SAXON also correctly.
getCurrentDocument
public DocumentInfo getCurrentDocument()
- Get the current document
- Returns:
- the document that has been most recently built using this builder
warning- Callback interface for SAX: not for application use
error- Callback interface for SAX: not for application use
fatalError- Callback interface for SAX: not for application use
reportErrorboolean isFatal)- Common routine for errors and fatal errors
setUnparsedEntity
public abstract void setUnparsedEntity(java.lang.String name, java.lang.String uri)- Set the URI for an unparsed entity in the document. Abstract method to be implemented in each subclass.
- Overrides:
setUnparsedEntityin classEmitter
getPublicId
public java.lang.String getPublicId()
getLineNumber
public int getLineNumber()
getColumnNumber
public int getColumnNumber()
Overview Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: INNER | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
The abstract Builder class is responsible for taking a stream of SAX events and constructing a Document tree. There is one concrete subclass for each tree implementation.
| Field Summary | |
protected int |
columnNumber
|
protected DocumentInfo |
currentDocument
|
protected boolean |
discardComments
|
errorHandler
|
|
errorListener
|
|
protected java.io.Writer |
errorOutput
|
protected int |
estimatedLength
|
protected boolean |
failed
|
protected boolean |
inDTD
|
protected int |
lineNumber
|
protected boolean |
lineNumbering
|
protected PreviewManager |
previewManager
|
static int |
STANDARD_TREE
|
protected boolean |
started
|
protected Stripper |
stripper
|
protected boolean |
timing
|
static int |
TINY_TREE
|
| Fields inherited from class com.icl.saxon.output.Emitter |
locator, namePool, outputProperties, outputStream, systemId, writer |
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING |
| Constructor Summary | |
Builder()
create a Builder and initialise variables |
|
Build the tree from an input source.
Callback interface for SAX: not for application use
Callback interface for SAX: not for application use boolean isFatal)
Common routine for errors and fatal errors
Set the SAX error handler to use.
Set the JAXP error listener to use, if no SAX errorHandler has been provided.
Callback interface for SAX: not for application use
| Method Summary | |
DocumentInfo |
|
void |
|
void |
|
int |
getColumnNumber()
|
DocumentInfo |
getCurrentDocument()
Get the current document |
int |
getLineNumber()
|
java.lang.String |
getPublicId()
|
Stripper |
getStripper()
Get the Stripper in use |
boolean |
isTiming()
Get timing option |
protected void |
|
void |
setDiscardCommentsAndPIs(boolean discard)
Indicate whether comments and Processing Instructions should be discarded |
void |
|
void |
|
void |
setErrorOutput(java.io.Writer writer)
Set output for error messages produced by the default error handler. The default error handler does not throw an exception for parse errors or input I/O errors, rather it returns a result code and writes diagnostics to a user-specified output writer, which defaults to System.err This call has no effect if setErrorHandler() has been called to supply a user-defined error handler |
void |
setLineNumbering(boolean onOrOff)
Set line numbering on or off |
void |
setPreviewManager(PreviewManager pm)
Set the PreviewManager to use |
void |
setRootNode(DocumentInfo doc)
Set the root (document) node to use. |
void |
setStripper(Stripper s)
Set the Stripper to use |
void |
setTiming(boolean on)
Set timing option on or off |
abstract void |
setUnparsedEntity(java.lang.String name,
java.lang.String uri)
Set the URI for an unparsed entity in the document. |
void |
|
| Methods inherited from class com.icl.saxon.output.Emitter |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
getSystemId |
getSystemId |
| Field Detail |
STANDARD_TREE
public static final int STANDARD_TREE
TINY_TREE
public static final int TINY_TREE
estimatedLength
protected int estimatedLength
errorOutput
protected java.io.Writer errorOutput
stripper
protected Stripper stripper
previewManager
protected PreviewManager previewManager
discardComments
protected boolean discardComments
currentDocument
protected DocumentInfo currentDocument
errorHandler
errorListener
failed
protected boolean failed
started
protected boolean started
timing
protected boolean timing
inDTD
protected boolean inDTD
lineNumbering
protected boolean lineNumbering
lineNumber
protected int lineNumber
columnNumber
protected int columnNumber
| Constructor Detail |
Builder
public Builder()
| Method Detail |
setRootNode
public void setRootNode(DocumentInfo doc)
setTiming
public void setTiming(boolean on)
isTiming
public boolean isTiming()
setLineNumbering
public void setLineNumbering(boolean onOrOff)
setStripper
public void setStripper(Stripper s)
getStripper
public Stripper getStripper()
setPreviewManager
public void setPreviewManager(PreviewManager pm)
setDiscardCommentsAndPIs
public void setDiscardCommentsAndPIs(boolean discard)
setErrorHandler