ro.sync.exml.plugin.transform

Interface XQueryTransformerPluginExtension

All Superinterfaces:

PluginExtension

All Known Subinterfaces:

SaxonXQueryTransformerPluginExtension

@API(type=EXTENDABLE,
     src=PUBLIC)
public interface XQueryTransformerPluginExtension
extends PluginExtension

A plugin extension that contributes an XQuery transformer.

Since:

18

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayTransformerName() Get the display transformer name.
java.lang.String	getTransformerName() Get the transformer name.
javax.xml.transform.Transformer	getXQueryTransformer(javax.xml.transform.Source source, javax.xml.transform.URIResolver uriResolver, boolean validationOnly) Get an XQuery transformer.
boolean	suportsAutomaticValidation() Checks if this transformer supports validation.

Method Detail

getTransformerName

java.lang.String getTransformerName()

Get the transformer name.

Returns:

The transformer name.

getDisplayTransformerName

java.lang.String getDisplayTransformerName()

Get the display transformer name.

Returns:

The display transformer name.

suportsAutomaticValidation

boolean suportsAutomaticValidation()

Checks if this transformer supports validation.

Returns:

true if automatic validation is supported.

getXQueryTransformer

javax.xml.transform.Transformer getXQueryTransformer(javax.xml.transform.Source source,
                                                     javax.xml.transform.URIResolver uriResolver,
                                                     boolean validationOnly)
                                              throws ro.sync.exml.editor.xmleditor.ErrorListException

Get an XQuery transformer.

Parameters:

source - The XQuery source.

uriResolver - The URI resolver.

validationOnly - true if the transformer is used only to compile the query, to see if there are any errors.

Returns:

The transformer if created.

Throws:

ro.sync.exml.editor.xmleditor.ErrorListException - Exceptions encountered while initializing the transformer.