Package net.sf.saxon.trace
Class ExpressionPresenter
java.lang.Object
net.sf.saxon.trace.ExpressionPresenter
This class handles the display of an abstract expression tree in an XML format
with some slight resemblance to XQueryX
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic interface -
Constructor Summary
ConstructorsConstructorDescriptionMake an uncommitted ExpressionPresenter.ExpressionPresenter(Configuration config) Make an ExpressionPresenter that writes indented output to the standard error output destination of the ConfigurationExpressionPresenter(Configuration config, StreamResult out) Make an ExpressionPresenter that writes indented output to a specified output streamExpressionPresenter(Configuration config, StreamResult out, boolean checksum) Make an ExpressionPresenter that writes indented output to a specified output stream, with checksummingExpressionPresenter(Configuration config, Receiver receiver) Make an ExpressionPresenter for a given Configuration using a user-supplied Receiver to accept the outputExpressionPresenter(Configuration config, Logger out) Make an ExpressionPresenter that writes indented output to a specified output stream -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Close the outputstatic ReceiverdefaultDestination(Configuration config, Logger out) Make a receiver, using default output properties, with serialized output going to a specified OutputStreamvoidemitAttribute(String name, String value) Output an attribute nodevoidemitAttribute(String name, StructuredQName value) Output a QName-valued attribute nodevoidintEnd an element in the expression treevoidEnd a child element in the outputGet the Saxon configurationGet the name poolGet the optionsGet the type hierarchy cachevoidinit(Configuration config, StreamResult out, boolean checksum) Make an ExpressionPresenter that writes indented output to a specified output stream, with checksummingvoidinit(Configuration config, Receiver out, boolean checksum) Make an ExpressionPresenter that writes indented output to a specified output stream, with checksummingbooleanAsk whether the package can be deployed to a different location, with a different base URIstatic StringStatic method to escape a string using Javascript escaping conventionsstatic SerializationPropertiesmakeDefaultProperties(Configuration config) Make a Properties object containing defaulted serialization attributes for the expression treevoidOutput a namespace declaration.voidsetChildRole(String role) Set the role of the next element to be outputvoidsetDefaultNamespace(String namespace) Set the default namespace, used for subsequent calls on startElement.voidsetOptions(ExpressionPresenter.Options options) Set the optionsvoidsetRelocatable(boolean relocatable) Say whether the package can be deployed to a different location, with a different base URIintstartElement(String name) Start an elementintstartElement(String name, Expression expr) Start an element representing an expression in the expression treevoidstartSubsidiaryElement(String name) Start a child element in the output
-
Constructor Details
-
ExpressionPresenter
public ExpressionPresenter()Make an uncommitted ExpressionPresenter. This must be followed by a call on init() -
ExpressionPresenter
Make an ExpressionPresenter that writes indented output to the standard error output destination of the Configuration- Parameters:
config- the Saxon configuration
-
ExpressionPresenter
Make an ExpressionPresenter that writes indented output to a specified output stream- Parameters:
config- the Saxon configurationout- the output destination
-
ExpressionPresenter
Make an ExpressionPresenter that writes indented output to a specified output stream, with checksumming- Parameters:
config- the Saxon configurationout- the output destinationchecksum- true if a checksum is to be written at the end of the file
-
ExpressionPresenter
Make an ExpressionPresenter that writes indented output to a specified output stream- Parameters:
config- the Saxon configurationout- the output stream
-
ExpressionPresenter
Make an ExpressionPresenter for a given Configuration using a user-supplied Receiver to accept the output- Parameters:
config- the Configurationreceiver- the user-supplied Receiver
-
-
Method Details
-
init
Make an ExpressionPresenter that writes indented output to a specified output stream, with checksumming- Parameters:
config- the Saxon configurationout- the output destinationchecksum- true if a checksum is to be written at the end of the file
-
init
Make an ExpressionPresenter that writes indented output to a specified output stream, with checksumming- Parameters:
config- the Saxon configurationout- the output destinationchecksum- true if a checksum is to be written at the end of the file
-
setDefaultNamespace
Set the default namespace, used for subsequent calls on startElement. Must be consistent throughout the whole document- Parameters:
namespace- the default namespace
-
setOptions
Set the options -
getOptions
Get the options- Returns:
- the options, or null if none have been set
-
isRelocatable
public boolean isRelocatable()Ask whether the package can be deployed to a different location, with a different base URI- Returns:
- if true then static-base-uri() represents the deployed location of the package, rather than its compile time location
-
setRelocatable
public void setRelocatable(boolean relocatable) Say whether the package can be deployed to a different location, with a different base URI- Parameters:
relocatable- if true then static-base-uri() represents the deployed location of the package, rather than its compile time location
-
defaultDestination
Make a receiver, using default output properties, with serialized output going to a specified OutputStream- Parameters:
config- the Configurationout- the OutputStream- Returns:
- a Receiver that directs serialized output to this output stream
- Throws:
XPathException
-
makeDefaultProperties
Make a Properties object containing defaulted serialization attributes for the expression tree- Returns:
- a default set of properties
-
startElement
Start an element representing an expression in the expression tree- Parameters:
name- the name of the elementexpr- the expression represented- Returns:
- the depth of the tree before this element: for diagnostics, this can be compared with the value returned by endElement
-
emitRetainedStaticContext
-
startElement
Start an element- Parameters:
name- the name of the element- Returns:
- the depth of the tree before this element: for diagnostics, this can be compared with the value returned by endElement
-
setChildRole
Set the role of the next element to be output- Parameters:
role- the value of the role output to be used
-
emitAttribute
Output an attribute node- Parameters:
name- the name of the attributevalue- the value of the attribute
-
emitAttribute
Output a QName-valued attribute node- Parameters:
name- the name of the attributevalue- the value of the attribute
-
namespace
Output a namespace declaration. All namespaces should be declared at the top level.- Parameters:
prefix- the namespace prefixuri- the namespace URI
-
endElement
public int endElement()End an element in the expression tree- Returns:
- the depth of the tree after ending this element. For diagnostics, this can be compared with the value returned by startElement()
-
startSubsidiaryElement
Start a child element in the output- Parameters:
name- the name of the child element
-
endSubsidiaryElement
public void endSubsidiaryElement()End a child element in the output -
close
public void close()Close the output -
getConfiguration
Get the Saxon configuration- Returns:
- the Saxon configuration
-
getNamePool
Get the name pool- Returns:
- the name pool
-
getTypeHierarchy
Get the type hierarchy cache- Returns:
- the type hierarchy cache
-
jsEscape
Static method to escape a string using Javascript escaping conventions- Parameters:
in- the string to be escaped
-