IRISLIB database
Transformer Class Reference
Inheritance diagram for Transformer:
Collaboration diagram for Transformer:

Static Public Member Functions

_.Library.Status AddToEvaluateCacheFilterList (_.Library.String filterListEntry, _.XML.XSLT.ErrorHandler pErrorHandler, _.Net.Remote.Gateway gateway)
 This method adds a function name to the evaluate cache filter list. More...
 
_.Library.Status ClearEvaluateCache (_.XML.XSLT.ErrorHandler pErrorHandler, _.Net.Remote.Gateway gateway)
 This method clears the evaluate cache. More...
 
_.Library.Status ClearEvaluateCacheFilterList (_.XML.XSLT.ErrorHandler pErrorHandler, _.Net.Remote.Gateway gateway)
 This method clears the evaluate cache filter list. More...
 
_.Library.Status DumpEvaluateCacheToList (_.Library.List evaluateCache, _.XML.XSLT.ErrorHandler pErrorHandler, _.Net.Remote.Gateway gateway)
 This method dumps the evaluate cache to a list, with the following format: More...
 
_.Library.Status LoadEvaluateCacheFromList (_.Library.List evaluateCache, _.XML.XSLT.ErrorHandler pErrorHandler, _.Net.Remote.Gateway gateway)
 This method loads (or pre-populates) the evaluate cache from a list, with the following format: More...
 
_.Library.Status RemoveFromEvaluateCacheFilterList (_.Library.String filterListEntry, _.XML.XSLT.ErrorHandler pErrorHandler, _.Net.Remote.Gateway gateway)
 This method removes a function name from the evaluate cache filter list. More...
 
_.Library.Status SetCacheEverythingBoolean (_.Library.Boolean cacheEverything, _.XML.XSLT.ErrorHandler pErrorHandler, _.Net.Remote.Gateway gateway)
 This method sets the cache everything boolean for the evaluate cache. More...
 
_.Library.Status SetEvaluateCacheSize (_.Library.Integer size, _.XML.XSLT.ErrorHandler pErrorHandler, _.Net.Remote.Gateway gateway)
 This method sets the maximum size of the evaluate cache. More...
 
_.Library.Status StartGateway (_.Net.Remote.Gateway gateway, _.Library.Boolean useSharedMemoryIfPossible)
 This method starts a gateway if there's not already one started, connects to it, and returns the gateway by reference. More...
 
_.Library.Status StopGateway (_.Net.Remote.Gateway gateway)
 This method disconnects from the gateway. More...
 
_.Library.Status TransformFile (_.Library.String pSource, _.Library.String pXSL, _.Library.String pOutput, _.XML.XSLT.ErrorHandler pErrorHandler, pParams, pCallbackHandler, _.XML.SAX.EntityResolver pResolver, _.Net.Remote.Gateway gateway)
 This method transforms a source file according to an XSL stylesheet and writes the output. More...
 
_.Library.Status TransformFileWithCompiledXSL (_.Library.String pSource, _.XML.XSLT2.CompiledStyleSheet pXSL, _.Library.String pOutput, _.XML.XSLT.ErrorHandler pErrorHandler, pParams, pCallbackHandler, _.XML.SAX.EntityResolver pResolver, _.Net.Remote.Gateway gateway)
 This method transforms a source file according to an XSL stylesheet and writes the output. More...
 
_.Library.Status TransformStream (_.Stream.Object pSource, _.Stream.Object pXSL, _.Library.BinaryStream pOutput, _.XML.XSLT.ErrorHandler pErrorHandler, pParams, pCallbackHandler, _.XML.SAX.EntityResolver pResolver, _.Net.Remote.Gateway gateway)
 This method transforms a source stream according to an XSL stylesheet and writes the output. More...
 
_.Library.Status TransformStreamWithCompiledXSL (_.Stream.Object pSource, _.XML.XSLT2.CompiledStyleSheet pXSL, _.Library.BinaryStream pOutput, _.XML.XSLT.ErrorHandler pErrorHandler, pParams, pCallbackHandler, _.XML.SAX.EntityResolver pResolver, _.Net.Remote.Gateway gateway)
 This method transforms a source stream according to an XSL stylesheet and writes the output. More...
 
_.Library.Status TransformStringWithCompiledXSL (_.Library.String pSource, _.XML.XSLT2.CompiledStyleSheet pXSL, _.Library.String pOutput, _.XML.XSLT.ErrorHandler pErrorHandler, pParams, pCallbackHandler, _.XML.SAX.EntityResolver pResolver, _.Net.Remote.Gateway gateway)
 This method transforms a source string according to an XSL stylesheet and returns the output. More...
 

Additional Inherited Members

- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Detailed Description

For details on using this class, see Performing XSLT Transformations.

Implements an interface to the XSLT 2.0 Parser. XML contained in a file or binary stream may be transformed

Member Function Documentation

◆ AddToEvaluateCacheFilterList()

_.Library.Status AddToEvaluateCacheFilterList ( _.Library.String  filterListEntry,
_.XML.XSLT.ErrorHandler  pErrorHandler,
_.Net.Remote.Gateway  gateway 
)
static

This method adds a function name to the evaluate cache filter list.

Note that this does not limit the cache size in any way. There may be any number of calls to the same function, but with different arguments and return values. Each combination of function name + arguments would be a separate entry in the cache. If errors occur during processing, callbacks will be made to the supplied error handler. If an error handler is not supplied then the default is to use a newly created instance of XML.XSLT.ErrorHandler.

◆ ClearEvaluateCache()

_.Library.Status ClearEvaluateCache ( _.XML.XSLT.ErrorHandler  pErrorHandler,
_.Net.Remote.Gateway  gateway 
)
static

This method clears the evaluate cache.

If errors occur during processing, callbacks will be made to the supplied error handler. If an error handler is not supplied then the default is to use a newly created instance of XML.XSLT.ErrorHandler.

◆ ClearEvaluateCacheFilterList()

_.Library.Status ClearEvaluateCacheFilterList ( _.XML.XSLT.ErrorHandler  pErrorHandler,
_.Net.Remote.Gateway  gateway 
)
static

This method clears the evaluate cache filter list.

If errors occur during processing, callbacks will be made to the supplied error handler. If an error handler is not supplied then the default is to use a newly created instance of XML.XSLT.ErrorHandler.

◆ DumpEvaluateCacheToList()

_.Library.Status DumpEvaluateCacheToList ( _.Library.List  evaluateCache,
_.XML.XSLT.ErrorHandler  pErrorHandler,
_.Net.Remote.Gateway  gateway 
)
static

This method dumps the evaluate cache to a list, with the following format:

   total number of cache entries
   for each entry:
       total number of evaluate arguments = function name + up to 9 arguments
       all evaluate arguments
       evaluate value

If errors occur during processing, callbacks will be made to the supplied error handler. If an error handler is not supplied then the default is to use a newly created instance of XML.XSLT.ErrorHandler.

◆ LoadEvaluateCacheFromList()

_.Library.Status LoadEvaluateCacheFromList ( _.Library.List  evaluateCache,
_.XML.XSLT.ErrorHandler  pErrorHandler,
_.Net.Remote.Gateway  gateway 
)
static

This method loads (or pre-populates) the evaluate cache from a list, with the following format:

   total number of cache entries
   for each entry:
       total number of evaluate arguments = function name + up to 9 arguments
       all evaluate arguments
       evaluate value

If errors occur during processing, callbacks will be made to the supplied error handler. If an error handler is not supplied then the default is to use a newly created instance of XML.XSLT.ErrorHandler.

◆ RemoveFromEvaluateCacheFilterList()

_.Library.Status RemoveFromEvaluateCacheFilterList ( _.Library.String  filterListEntry,
_.XML.XSLT.ErrorHandler  pErrorHandler,
_.Net.Remote.Gateway  gateway 
)
static

This method removes a function name from the evaluate cache filter list.

If errors occur during processing, callbacks will be made to the supplied error handler. If an error handler is not supplied then the default is to use a newly created instance of XML.XSLT.ErrorHandler.

◆ SetCacheEverythingBoolean()

_.Library.Status SetCacheEverythingBoolean ( _.Library.Boolean  cacheEverything,
_.XML.XSLT.ErrorHandler  pErrorHandler,
_.Net.Remote.Gateway  gateway 
)
static

This method sets the cache everything boolean for the evaluate cache.

This overrides the filter list and allows calls to all functions to be cached. If errors occur during processing, callbacks will be made to the supplied error handler. If an error handler is not supplied then the default is to use a newly created instance of XML.XSLT.ErrorHandler.

◆ SetEvaluateCacheSize()

_.Library.Status SetEvaluateCacheSize ( _.Library.Integer  size,
_.XML.XSLT.ErrorHandler  pErrorHandler,
_.Net.Remote.Gateway  gateway 
)
static

This method sets the maximum size of the evaluate cache.

The default size is 1000.

If errors occur during processing, callbacks will be made to the supplied error handler. If an error handler is not supplied then the default is to use a newly created instance of XML.XSLT.ErrorHandler.

◆ StartGateway()

_.Library.Status StartGateway ( _.Net.Remote.Gateway  gateway,
_.Library.Boolean  useSharedMemoryIfPossible 
)
static

This method starts a gateway if there's not already one started, connects to it, and returns the gateway by reference.

This method does not change the current device.

◆ StopGateway()

_.Library.Status StopGateway ( _.Net.Remote.Gateway  gateway)
static

This method disconnects from the gateway.

It does not stop the gateway.

◆ TransformFile()

_.Library.Status TransformFile ( _.Library.String  pSource,
_.Library.String  pXSL,
_.Library.String  pOutput,
_.XML.XSLT.ErrorHandler  pErrorHandler,
  pParams,
  pCallbackHandler,
_.XML.SAX.EntityResolver  pResolver,
_.Net.Remote.Gateway  gateway 
)
static

This method transforms a source file according to an XSL stylesheet and writes the output.

to the specified output file. If errors occur during processing, callbacks will be made to the supplied error handler. If an error handler is not supplied then the default is to use a newly created instance of XML.XSLT.ErrorHandler. The pParams argument is either a CoS array, or ArrayOfDataTypes of name/value pairs to be passed as $ variables.

◆ TransformFileWithCompiledXSL()

_.Library.Status TransformFileWithCompiledXSL ( _.Library.String  pSource,
_.XML.XSLT2.CompiledStyleSheet  pXSL,
_.Library.String  pOutput,
_.XML.XSLT.ErrorHandler  pErrorHandler,
  pParams,
  pCallbackHandler,
_.XML.SAX.EntityResolver  pResolver,
_.Net.Remote.Gateway  gateway 
)
static

This method transforms a source file according to an XSL stylesheet and writes the output.

to the specified output file. If errors occur during processing, callbacks will be made to the supplied error handler. If an error handler is not supplied then the default is to use a newly created instance of XML.XSLT.ErrorHandler. The pParams argument is either a CoS array, or ArrayOfDataTypes of name/value pairs to be passed as $ variables.

◆ TransformStream()

_.Library.Status TransformStream ( _.Stream.Object  pSource,
_.Stream.Object  pXSL,
_.Library.BinaryStream  pOutput,
_.XML.XSLT.ErrorHandler  pErrorHandler,
  pParams,
  pCallbackHandler,
_.XML.SAX.EntityResolver  pResolver,
_.Net.Remote.Gateway  gateway 
)
static

This method transforms a source stream according to an XSL stylesheet and writes the output.

to the supplied binary stream. If errors occur during processing, callbacks will be made to the supplied error handler. If an error handler is not supplied then the default is to use a newly created instance of XML.XSLT.ErrorHandler. The pParams argument is either a CoS array, or ArrayOfDataTypes of name/value pairs to be passed as $ variables. Note that that the XSLT transform engine will produce a stream with line terminator $c(10), regardless of the line terminator of the input stream. If an existing output stream is passed to this method, its LineTerminator property will be set to $c(10), so anything written to the stream before calling this method should also use $c(10) as its line terminator.

◆ TransformStreamWithCompiledXSL()

_.Library.Status TransformStreamWithCompiledXSL ( _.Stream.Object  pSource,
_.XML.XSLT2.CompiledStyleSheet  pXSL,
_.Library.BinaryStream  pOutput,
_.XML.XSLT.ErrorHandler  pErrorHandler,
  pParams,
  pCallbackHandler,
_.XML.SAX.EntityResolver  pResolver,
_.Net.Remote.Gateway  gateway 
)
static

This method transforms a source stream according to an XSL stylesheet and writes the output.

to the supplied binary stream. If errors occur during processing, callbacks will be made to the supplied error handler. If an error handler is not supplied then the default is to use a newly created instance of XML.XSLT.ErrorHandler. The pParams argument is either a CoS array, or ArrayOfDataTypes of name/value pairs to be passed as $ variables. Note that that the XSLT transform engine will produce a stream with line terminator $c(10), regardless of the line terminator of the input stream. If an existing output stream is passed to this method, its LineTerminator property will be set to $c(10), so anything written to the stream before calling this method should also use $c(10) as its line terminator.

◆ TransformStringWithCompiledXSL()

_.Library.Status TransformStringWithCompiledXSL ( _.Library.String  pSource,
_.XML.XSLT2.CompiledStyleSheet  pXSL,
_.Library.String  pOutput,
_.XML.XSLT.ErrorHandler  pErrorHandler,
  pParams,
  pCallbackHandler,
_.XML.SAX.EntityResolver  pResolver,
_.Net.Remote.Gateway  gateway 
)
static

This method transforms a source string according to an XSL stylesheet and returns the output.

to the supplied string. If errors occur during processing, callbacks will be made to the supplied error handler. If an error handler is not supplied then the default is to use a newly created instance of XML.XSLT.ErrorHandler. The pParams argument is either a CoS array, or ArrayOfDataTypes of name/value pairs to be passed as $ variables.