A B C E F G H I N O P R S T U W X

A

ABORT - Static variable in class com.ddtek.xmlconverter.Configuration

Value for setBufferOverflowPolicy and setTempFilePolicy.

B

BINARY - Static variable in class com.stylusstudio.xmlpipeline.runtime.ContentType

Indicates that the associated data object contains binary data.

bindInputObject(String, Object, ContentType) - Method in interface com.stylusstudio.xmlpipeline.runtime.PipelineOperation

Bind a DOM, InputStream, or a String to the named Pipeline Input node.

bindInputUrl(String, String, ContentType) - Method in interface com.stylusstudio.xmlpipeline.runtime.PipelineOperation

Bind a URL to the named Pipeline Input node.

bindOutputObject(String, Object) - Method in interface com.stylusstudio.xmlpipeline.runtime.PipelineOperation

Bind a DOM or OutputStream to the named Pipeline Output node.

bindOutputUrl(String, String) - Method in interface com.stylusstudio.xmlpipeline.runtime.PipelineOperation

Bind a Pipeline Output node to a URL.

C

Configuration - class com.ddtek.xmlconverter.Configuration.

A Configuration object contains user settable policies that govern certain aspects of the conversion process.

ContentType - class com.stylusstudio.xmlpipeline.runtime.ContentType.

The static fields of this class are used to identify what type of data is being processed by a Stylus Studio XML Pipeline.

Conversion - class com.ddtek.xmlconverter.Conversion.

A Conversion object contains all the information needed during an ongoing conversion.

Conversion() - Constructor for class com.ddtek.xmlconverter.Conversion

ConversionStatus - class com.ddtek.xmlconverter.ConversionStatus.

A class which contains status information for a Conversion.

ConversionStatus() - Constructor for class com.ddtek.xmlconverter.ConversionStatus

ConvertFromXML - interface com.ddtek.xmlconverter.ConvertFromXML.

An extension of the Converter interface which specifies methods used only in conversions from XML data to non-XML format data.

ConvertToXML - interface com.ddtek.xmlconverter.ConvertToXML.

An extension of the Converter interface which specifies methods used only in conversions from non-XML data to XML.

Converter - interface com.ddtek.xmlconverter.Converter.

Instances of this class perform conversion from XML to non-XML, and vice versa.

ConverterArgumentException - exception com.ddtek.xmlconverter.exception.ConverterArgumentException.

This exception is thrown if Converter.convert is called with an incorrect Source or Result argument.

ConverterCancelledException - exception com.ddtek.xmlconverter.exception.ConverterCancelledException.

This exception is created if the user application calls Conversion.cancel().

ConverterException - exception com.ddtek.xmlconverter.exception.ConverterException.

Most Exceptions from DataDirect XML Converters are reported as instances of this exception or its subclasses.

ConverterFactory - class com.ddtek.xmlconverter.ConverterFactory.

A factory class which is used to create new Converter, ConverterResolver and SchemaGenerator objects.

ConverterFactory() - Constructor for class com.ddtek.xmlconverter.ConverterFactory

Creates a new ConverterFactory.

ConverterListener - interface com.ddtek.xmlconverter.ConverterListener.

This is the error reporting interface for Converter errors.

ConverterResolver - class com.ddtek.xmlconverter.ConverterResolver.

An implementation of URIResolver which can resolve Converter URIs and many others.

canAcceptSAX(String) - Method in interface com.stylusstudio.xmlpipeline.runtime.PipelineOperation

Determine if the named Pipeline Input node is able to accept SAX events.

cancel() - Method in class com.ddtek.xmlconverter.Conversion

Attempt to cancel a Conversion.

cancel(Throwable) - Method in class com.ddtek.xmlconverter.Conversion

Attempt to cancel a conversion with an exception.

close() - Method in interface com.stylusstudio.xmlpipeline.runtime.PipelineOperation

Close all nodes in this pipeline and release all operating system resources.

com.ddtek.xmlconverter - package com.ddtek.xmlconverter

Contains the Java language API for DataDirect XML Converters 3.0

com.ddtek.xmlconverter.adapter.edi - package com.ddtek.xmlconverter.adapter.edi

Contains specialized ConverterExceptions for the EDI converter.

com.ddtek.xmlconverter.exception - package com.ddtek.xmlconverter.exception

Contains Exceptions thrown by DataDirect XML Converters 3.0

com.stylusstudio.xmlpipeline.runtime - package com.stylusstudio.xmlpipeline.runtime

Contains the Java language API for the DataDirect pipeline runtime modules.

convert(Source, Result) - Method in interface com.ddtek.xmlconverter.Converter

Start the conversion and (possibly) wait for completion.

createInputStream(String, String) - Method in class com.ddtek.xmlconverter.ConverterResolver

A convenience method to resolve a Stylus Studio URI and return an InputStream.

createOutputStream(String, String) - Method in class com.ddtek.xmlconverter.ConverterResolver

A convenience method to resolve a Stylus Studio URI and return an OutputStream.

E

EDIConverterException - exception com.ddtek.xmlconverter.adapter.edi.EDIConverterException.

This is a specialized version of ConverterException which contains extra information about the context of errors in EDI files.

EDIConverterException(String) - Constructor for class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

EDIConverterException(Throwable) - Constructor for class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

EDIConverterException(String, Throwable) - Constructor for class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

EmptyFileException - exception com.ddtek.xmlconverter.exception.EmptyFileException.

This exception may be thrown by the dBase converter.

error(ConverterException) - Method in interface com.ddtek.xmlconverter.ConverterListener

Receive notification of a recoverable error.

F

FAILED - Static variable in class com.ddtek.xmlconverter.ConversionStatus

A status value indicating the conversion has failed or was cancelled.

FINISHED - Static variable in class com.ddtek.xmlconverter.ConversionStatus

A status value indicating the conversion finished successfully.

fatalError(ConverterException) - Method in interface com.ddtek.xmlconverter.ConverterListener

Receive notification of a non-recoverable error.

G

getBufferOverflowPolicy() - Method in class com.ddtek.xmlconverter.Configuration

Get the current value of the memory buffer overflow policy.

getConfiguration() - Method in interface com.ddtek.xmlconverter.Converter

Get the Configuration object for this Converter.

getConfiguration() - Method in class com.ddtek.xmlconverter.ConverterFactory

Get a reference to the Configuration object in this ConverterFactory.

getConfiguration() - Method in class com.ddtek.xmlconverter.ConverterResolver

Get the Configuration associated with this ConverterResolver.

getContentData(int) - Method in class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

Fetch a specific value from the segment currently being processed.

getContentData(int, int) - Method in class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

Fetch a specific value from the segment currently being processed.

getContentData(int, int, int) - Method in class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

Fetch a specific value from the segment currently being processed.

getContentData(int, int, int, int) - Method in class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

Fetch a specific value from the segment currently being processed.

getContentHandler(Result) - Method in interface com.ddtek.xmlconverter.ConvertFromXML

Get a ContentHandler which can receive XML data to be converted to non-XML format.

getContentHandler(String) - Method in interface com.stylusstudio.xmlpipeline.runtime.PipelineOperation

Get a ContentHandler with which SAX events can be sent to the named Pipeline Input node.

getControlData(String, int) - Method in class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

Fetch a specific value from an element of the last-seen control segment of the given name.

getControlData(String, int, int) - Method in class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

Fetch a specific value from an element of the last-seen control segment of the given name.

getConversionStatus() - Method in class com.ddtek.xmlconverter.Conversion

Get the current status of this Conversion.

getConverterListener() - Method in class com.ddtek.xmlconverter.Configuration

Return the current ConverterListener

getData() - Method in class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

The value of the element being processed at the time of an error

getDialect() - Method in class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

The major EDI dialect

getElement() - Method in class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

Element name if appropriate, or null.

getElementPosition() - Method in class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

Returns the number of the element relative to the segment.

getEncoding() - Method in class com.ddtek.xmlconverter.OutputResult

Get the character encoding for a byte stream or URI.

getErrorHandler() - Method in interface com.ddtek.xmlconverter.Converter

Get the ErrorHandler previously set with setErrorHandler.

getErrorListener() - Method in interface com.ddtek.xmlconverter.Converter

Get the ErrorListener previously set with setErrorListener.

getException() - Method in class com.ddtek.xmlconverter.ConversionStatus

Get the Throwable which was thrown if the conversion failed or was cancelled.

getFactory() - Method in class com.ddtek.xmlconverter.ConverterResolver

Get the ConverterFactory which created this ConverterResolver.

getInputStream() - Method in class com.ddtek.xmlconverter.InputStreamResult

Get the InputStream, which is used to read the result data.

getLine() - Method in class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

Line number of error, treating each new segment as a new line.

getMaxBufferSize() - Method in class com.ddtek.xmlconverter.Configuration

Get the current size limit for the memory buffer.

getMessage() - Method in class com.stylusstudio.xmlpipeline.runtime.PipelineException

Get the detail message for this exception.

getNativeCode() - Method in class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

Error code relative to EDI dialect

getNativeTable() - Method in class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

Table from which error code for local EDI dialect is drawn.

getOffset() - Method in class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

When available, character offset from the start of the segment.

getOutputStream(Result) - Method in interface com.ddtek.xmlconverter.Converter

Get a OutputStream to write the input data to.

getOutputStream() - Method in class com.ddtek.xmlconverter.OutputStreamSource

Get the OutputStream, which is used to write the source data.

getProperty(String, String) - Method in class com.ddtek.xmlconverter.Configuration

Get the current value of a property which affects the behavior of an XML Converter.

getReader() - Method in class com.ddtek.xmlconverter.ReaderResult

Get the Reader, which is used to read the result data.

getRepetition() - Method in class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

Returns the repetition number for the element within the segment.

getSAXSource(Source) - Method in interface com.ddtek.xmlconverter.ConvertToXML

Get a SAXSource to read the converted data.

getSAXSource(String, String) - Method in class com.ddtek.xmlconverter.ConverterResolver

Resolve a url and return a SAXSource which can be used to read the data.

getSAXSource() - Method in interface com.ddtek.xmlconverter.SchemaGenerator

Create an XML Schema and make it available as a SAXSource.

getSAXSource(Source) - Method in interface com.ddtek.xmlconverter.SchemaGenerator

Create an XML Schema and make it available as a SAXSource.

getSchema(Result) - Method in interface com.ddtek.xmlconverter.SchemaGenerator

Create an XML Schema and write it to the specified result object.

getSchema(Source, Result) - Method in interface com.ddtek.xmlconverter.SchemaGenerator

Create an XML Schema and write it to the specified result object.

getSegment() - Method in class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

Name of segment containing error, or null.

getSeverity() - Method in class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

Level of severity of exception

getStatus() - Method in class com.ddtek.xmlconverter.ConversionStatus

Gets the current status of the Conversion.

getSubElementPosition() - Method in class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

Returns the number of the element relative to the composite element.

getSubSubElementPosition() - Method in class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

Returns the number of the element relative to the composite element nested within another composite.

getSystemId() - Method in class com.ddtek.xmlconverter.InputStreamResult

Get the SystemId of the result data.

getSystemId() - Method in class com.ddtek.xmlconverter.OutputStreamSource

Get the SystemId of the result data.

getSystemId() - Method in class com.ddtek.xmlconverter.ReaderResult

Get the SystemId of the result data.

getSystemId() - Method in class com.ddtek.xmlconverter.WriterSource

Get the SystemId of the result data.

getSystemId() - Method in class com.ddtek.xmlconverter.XMLStreamReaderResult

Get the SystemId of the result data.

getSystemId() - Method in class com.ddtek.xmlconverter.XMLStreamReaderSource

Get the SystemId of the source data.

getSystemId() - Method in class com.ddtek.xmlconverter.XMLStreamWriterResult

Get the SystemId of the result data.

getSystemId() - Method in class com.ddtek.xmlconverter.XMLStreamWriterSource

Get the SystemId of the source data.

getTempFilePolicy() - Method in class com.ddtek.xmlconverter.Configuration

Get the current value of the temp file policy.

getTransactionSet() - Method in class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

Message name/Transaction set number in which the error occurred, or null.

getVersion() - Method in class com.ddtek.xmlconverter.adapter.edi.EDIConverterException

A string of any versions or releases specified in the EDI file.

getWriter() - Method in class com.ddtek.xmlconverter.WriterSource

Get the Writer which is used to write the source data.

getXMLStreamReader(Source) - Method in interface com.ddtek.xmlconverter.ConvertToXML

Get an XMLStreamReader to read the converted data.

getXMLStreamReader(String, String) - Method in class com.ddtek.xmlconverter.ConverterResolver

Resolve a url and return a XMLStreamReader to read the data.

getXMLStreamReader() - Method in interface com.ddtek.xmlconverter.SchemaGenerator

Create an XML Schema and make it available as an XMLStreamReader.

getXMLStreamReader(Source) - Method in interface com.ddtek.xmlconverter.SchemaGenerator

Create an XML Schema and make it available as an XMLStreamReader.

getXMLStreamReader() - Method in class com.ddtek.xmlconverter.XMLStreamReaderResult

Get the XMLStreamReader which is used to read the result data.

getXMLStreamWriter(Result) - Method in interface com.ddtek.xmlconverter.ConvertFromXML

Get an XMLStreamWriter which can receive XML data to be converted to non-XML format.

getXMLStreamWriter() - Method in class com.ddtek.xmlconverter.XMLStreamWriterSource

Get the XMLStreamWriter which will be used to write the source data.

go() - Method in interface com.stylusstudio.xmlpipeline.runtime.PipelineOperation

Execute the pipeline and wait for it to terminate.

H

HTML - Static variable in class com.stylusstudio.xmlpipeline.runtime.ContentType

Indicates that the associated data object contains html data.

I

InputStreamResult - class com.ddtek.xmlconverter.InputStreamResult.

The class InputStreamResult is used to specify that the user of Converter wants to read the result of the conversion with a InputStream.

InputStreamResult() - Constructor for class com.ddtek.xmlconverter.InputStreamResult

Create an empty InputStreamResult.

InternalConverterError - exception com.ddtek.xmlconverter.exception.InternalConverterError.

This exception is thrown if an internal error is dectected in a DataDirect XML Converter.

InvalidFormatException - exception com.ddtek.xmlconverter.exception.InvalidFormatException.

This exception is thrown if invalid data is detected when converting non-XML data to XML.

isReady(String) - Method in interface com.stylusstudio.xmlpipeline.runtime.PipelineOperation

Check if any data was written to the named output port.

N

newConvertFromXML(String) - Method in class com.ddtek.xmlconverter.ConverterFactory

Create a new ConvertFromXML which can convert XML data to a non-XML format.

newConvertToXML(String) - Method in class com.ddtek.xmlconverter.ConverterFactory

Create a new ConvertToXML which can convert non-XML data to XML.

newConvertToXML(Source) - Method in class com.ddtek.xmlconverter.ConverterFactory

Create a new ConvertToXML which can perform Custom XML Conversions.

newResolver() - Method in class com.ddtek.xmlconverter.ConverterFactory

Create a new instance of ConverterResolver.

newSchemaGenerator(String) - Method in class com.ddtek.xmlconverter.ConverterFactory

Create a new SchemaGenerator which can produce an XML schema file for a specific XML Converter.

newSchemaGenerator(Source) - Method in class com.ddtek.xmlconverter.ConverterFactory

Create a new SchemaGenerator which can produce an XML schema file for a specific Custom XML Conversion.

O

OutputResult - class com.ddtek.xmlconverter.OutputResult.

The class OutputResult is used to specify that the user of Converter wants the Converter to write its output to a Writer provided by the caller, or wants the Converter to write its output to a OutputStream provided by the caller using a specified byte encoding.

OutputResult() - Constructor for class com.ddtek.xmlconverter.OutputResult

Default constructor.

OutputResult(OutputStream) - Constructor for class com.ddtek.xmlconverter.OutputResult

Construct an OutputResult from a byte stream (OutputStream).

OutputResult(Writer) - Constructor for class com.ddtek.xmlconverter.OutputResult

Construct an OutputResult from a character stream (Writer).

OutputResult(String) - Constructor for class com.ddtek.xmlconverter.OutputResult

Construct an OutputResult from a URI.

OutputStreamSource - class com.ddtek.xmlconverter.OutputStreamSource.

The class OutputStreamSource is used to specify that the user of Converter wants to provide the source data for the conversion by writing it to a OutputStream.

OutputStreamSource() - Constructor for class com.ddtek.xmlconverter.OutputStreamSource

Create an empty OutputStreamSource.

outputStreamResolver(String, String) - Method in class com.ddtek.xmlconverter.ConverterResolver

Resolve a URI and return a Result which can be used to write data to the URI.

P

PipelineException - exception com.stylusstudio.xmlpipeline.runtime.PipelineException.

All errors from the Stylus Studio XML Pipeline java runtime are reported as instances of this exception.

PipelineException(String) - Constructor for class com.stylusstudio.xmlpipeline.runtime.PipelineException

Constructs a new exception with the specified detail message.

PipelineException(String, Throwable) - Constructor for class com.stylusstudio.xmlpipeline.runtime.PipelineException

Constructs a new exception with the specified detail message and cause.

PipelineOperation - interface com.stylusstudio.xmlpipeline.runtime.PipelineOperation.

The java code for a Stylus Studio XML Pipeline implements this interface.

R

RUNNING - Static variable in class com.ddtek.xmlconverter.ConversionStatus

A status value indicating the conversion is still running.

ReaderResult - class com.ddtek.xmlconverter.ReaderResult.

The ReaderResult is used to specify that the user of Converter wants to read the result of the conversion with a Reader.

ReaderResult() - Constructor for class com.ddtek.xmlconverter.ReaderResult

Create an empty ReaderResult.

requiresSource() - Method in interface com.ddtek.xmlconverter.SchemaGenerator

Determine whether this SchemaGenerator will require an instance of the native data file to generate the XML Schema.

resolve(String, String) - Method in class com.ddtek.xmlconverter.ConverterResolver

Resolve a URI and return a Source which can be used to read data from the URI.

S

SchemaGenerator - interface com.ddtek.xmlconverter.SchemaGenerator.

A SchemaGenerator is used to create XML Schema files which describe the structure of xml files read or created by a Converter, ConvertToXML or ConvertFromXML object.

StreamClosedException - exception com.ddtek.xmlconverter.exception.StreamClosedException.

Exception thrown to indicate the converter is no longer accepting input data.

setBaseURI(String) - Method in interface com.stylusstudio.xmlpipeline.runtime.PipelineOperation

Set the BaseURI to be used while executing the pipeline.

setBufferOverflowPolicy(int) - Method in class com.ddtek.xmlconverter.Configuration

Set the memory buffer overflow policy.

setConverterListener(ConverterListener) - Method in class com.ddtek.xmlconverter.Configuration

Set a ConverterListener

setEncoding(String) - Method in class com.ddtek.xmlconverter.OutputResult

Set the character encoding.

setErrorHandler(ErrorHandler) - Method in interface com.ddtek.xmlconverter.Converter

Set an ErrorHandler to which errors should be reported by the converter.

setErrorListener(ErrorListener) - Method in interface com.ddtek.xmlconverter.Converter

Set an ErrorListener to which errors should be reported by the converter.

setMaxBufferSize(int) - Method in class com.ddtek.xmlconverter.Configuration

Set the maximum size limit for the memory buffer.

setProperty(String, String) - Method in class com.ddtek.xmlconverter.Configuration

Set a property which affects the behavior of an XML Converter.

setSystemId(String) - Method in class com.ddtek.xmlconverter.XMLStreamReaderResult

Set the SystemId of the result data.

setSystemId(String) - Method in class com.ddtek.xmlconverter.XMLStreamReaderSource

Set the SystemId of the source data.

setSystemId(String) - Method in class com.ddtek.xmlconverter.XMLStreamWriterResult

Set the SystemId of the result data.

setSystemId(String) - Method in class com.ddtek.xmlconverter.XMLStreamWriterSource

Set the SystemId of the source data.

setTempFilePolicy(int) - Method in class com.ddtek.xmlconverter.Configuration

Set the temp file policy.

T

TEXT - Static variable in class com.stylusstudio.xmlpipeline.runtime.ContentType

Indicates that the associated data object contains text (character string) data.

U

UNKNOWN - Static variable in class com.stylusstudio.xmlpipeline.runtime.ContentType

Indicates that the content type of the associated data item is unknown.

UNLIMITED_BUFFER - Static variable in class com.ddtek.xmlconverter.Configuration

Value for setMaxBufferSize to indicate there should be no limit.

USE_MEMORY - Static variable in class com.ddtek.xmlconverter.Configuration

Value for setTempFilePolicy.

USE_TEMP_FILE - Static variable in class com.ddtek.xmlconverter.Configuration

Value for setBufferOverflowPolicy.

W

WriterSource - class com.ddtek.xmlconverter.WriterSource.

The class WriterSource is used to specify that the user of Converter wants to provide the source data for the conversion by writing it to a Writer.

WriterSource() - Constructor for class com.ddtek.xmlconverter.WriterSource

Create an empty WriterSource.

warning(ConverterException) - Method in interface com.ddtek.xmlconverter.ConverterListener

Receive notification of a warning.

X

XML - Static variable in class com.stylusstudio.xmlpipeline.runtime.ContentType

Indicates that the associated data object contains well-formed xml data.

XMLStreamReaderResult - class com.ddtek.xmlconverter.XMLStreamReaderResult.

The XMLStreamReaderResult is used to specify that the user of Converter wants to read the result of the conversion with an XMLStreamReader.

XMLStreamReaderResult() - Constructor for class com.ddtek.xmlconverter.XMLStreamReaderResult

Create an empty XMLStreamReaderResult.

XMLStreamReaderSource - class com.ddtek.xmlconverter.XMLStreamReaderSource.

The XMLStreamReaderSource is used to specify that the user of Converter wants to supply the source data to the conversion with an XMLStreamReader.

XMLStreamReaderSource(XMLStreamReader) - Constructor for class com.ddtek.xmlconverter.XMLStreamReaderSource

Create the XMLStreamReaderSource, supplying the source data with an XMLStreamReader.

XMLStreamWriterResult - class com.ddtek.xmlconverter.XMLStreamWriterResult.

The XMLStreamWriterResult is used to specify that the user of Converter wants the result data to be written to an XMLStreamWriter.

XMLStreamWriterResult(XMLStreamWriter) - Constructor for class com.ddtek.xmlconverter.XMLStreamWriterResult

Create the XMLStreamWriterResult, supplying the XMLStreamWriter which is to receive the result data.

XMLStreamWriterSource - class com.ddtek.xmlconverter.XMLStreamWriterSource.

The class XMLStreamWriterSource is used to specify that the user of Converter wants to provide the source data for the conversion by writing it to an XMLStreamWriter.

XMLStreamWriterSource() - Constructor for class com.ddtek.xmlconverter.XMLStreamWriterSource

Create an empty XMLStreamWriterSource.

A B C E F G H I N O P R S T U W X