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

A

ABORT - Static variable in class com.stylusstudio.converter.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.

buildDirectoryStructure(String) - Method in interface com.exln.stylus.io.StylusFileSystem

Create a hierarchy of directories as specified by the parameter path.

C

Configuration - class com.stylusstudio.converter.Configuration.

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

Configuration() - Constructor for class com.stylusstudio.converter.Configuration

-EXCLUDE- Create a new Configuration object with default policy values.

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 - interface com.stylusstudio.converter.Conversion.

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

Converter - interface com.stylusstudio.converter.Converter.

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

ConverterException - exception com.stylusstudio.converter.ConverterException.

All Exceptions from convert(Source, Result) or convert(Source, Result, ErrorListener) are reported as instances of this exception.

ConverterException(String) - Constructor for class com.stylusstudio.converter.ConverterException

ConverterException(Throwable) - Constructor for class com.stylusstudio.converter.ConverterException

ConverterException(String, Throwable) - Constructor for class com.stylusstudio.converter.ConverterException

ConverterFactory - class com.stylusstudio.converter.ConverterFactory.

A factory class which is used to create new Converter objects.

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

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

canChangeServers() - Method in interface com.exln.stylus.io.StylusFileSystem

canCreateDirectories() - Method in interface com.exln.stylus.io.StylusFileSystem

Check whether this custom file system can create directories.

cancel() - Method in interface com.stylusstudio.converter.Conversion

Attempt to cancel a Conversion.

cancel(Exception) - Method in interface com.stylusstudio.converter.Conversion

Attempt to cancel a Conversion.

close() - Method in interface com.exln.stylus.io.StylusFile

Close and release any resources held by this StylusFile object.

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

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

com.exln.stylus.io - package com.exln.stylus.io

com.stylusstudio.converter - package com.stylusstudio.converter

com.stylusstudio.version - package com.stylusstudio.version

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

connectServer(String) - Method in interface com.exln.stylus.io.StylusFileSystem

convert(Source, Result) - Method in interface com.stylusstudio.converter.Converter

Start the conversion and (possibly) wait for completion.

convert(Source, Result, ErrorListener) - Method in interface com.stylusstudio.converter.Converter

Start the conversion and (possibly) wait for completion.

copyFromFile(String) - Method in interface com.exln.stylus.io.StylusFile

Copy the contents of a named file to this StylusFile.

copyFromFile(StylusFile, String) - Static method in class com.exln.stylus.io.StylusFileHelpers

Perform the copyFromFile function of the StylusFile interface.

copyFromStream(StylusFile, InputStream) - Static method in class com.exln.stylus.io.StylusFileHelpers

Copy data from an InputStream object to a StylusFile object.

copyToFile(String) - Method in interface com.exln.stylus.io.StylusFile

Copy the contents of this StylusFile to a named file.

copyToFile(StylusFile, String) - Static method in class com.exln.stylus.io.StylusFileHelpers

Perform the copyToFile function of the StylusFile interface.

copyToStream(StylusFile, OutputStream) - Static method in class com.exln.stylus.io.StylusFileHelpers

Copy data from a StylusFile object to a Stream object.

createIOException(Throwable) - Static method in class com.exln.stylus.io.StylusFileHelpers

Convert an exception into an IOException.

createInputStream(String, String) - Static method in class com.exln.stylus.io.StylusFileFactory

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

createOutputResult(String, String) - Static method in class com.exln.stylus.io.StylusFileFactory

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

createOutputStream(String, String) - Static method in class com.exln.stylus.io.StylusFileFactory

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

createSource(String, String, boolean) - Static method in class com.exln.stylus.io.StylusFileFactory

A convenience method to resolve a Stylus Studio uri and return a StreamSource.

createStylusFile(String) - Method in class com.exln.stylus.io.StylusFileFactory

Create a StylusFile object for file access through a custom file system.

createStylusFile(String, InputStream) - Method in class com.exln.stylus.io.StylusFileFactory

Create a StylusFile object for file access through a custom file system.

createStylusFile(String, OutputStream) - Method in class com.exln.stylus.io.StylusFileFactory

Create a StylusFile object for file access through a custom file system.

createXMLReader() - Static method in class com.exln.stylus.io.StylusFileHelpers

Create an XMLReader implementation instance.

D

deleteItem(String) - Method in interface com.exln.stylus.io.StylusFileSystemOptions

Delete a file within the custom file system.

disconnectServer() - Method in interface com.exln.stylus.io.StylusFileSystem

doCopy(InputStream, OutputStream) - Static method in class com.exln.stylus.io.StylusFileHelpers

Copy data from an InputStream to an OutputStream using a 64K buffer.

doINFO() - Static method in class com.exln.stylus.io.StylusFileHelpers

Return whether the INFO method will generate any output.

doTRACE() - Static method in class com.exln.stylus.io.StylusFileHelpers

Return whether the TRACE method will generate any output.

E

exceedsBufferLimit(int) - Method in class com.stylusstudio.converter.Configuration

-EXCLUDE- Return true if the request exceeds the maximum buffer size.

exists(String) - Method in interface com.exln.stylus.io.StylusFileSystem

Check whether a file exists.

F

FROM_XML - Static variable in interface com.stylusstudio.converter.Converter

-EXCLUDE-

G

getAdapterClassLoader() - Static method in class com.exln.stylus.io.StylusFileFactory

-EXCLUDE- For internal use only please.

getAdditionalFileExtension() - Method in interface com.exln.stylus.io.StylusFileSystemOptions

Get an additional file extension for this custom file system.

getBinDir() - Static method in class com.exln.stylus.io.StylusFileHelpers

Get the name of the directory containing CustomFileSystem.jar.

getBufferOverflowPolicy() - Method in class com.stylusstudio.converter.Configuration

Get the current value of the memory buffer overflow policy.

getBuildNumber() - Static method in class com.stylusstudio.version.Version

Get the Build number for this version of the product.

getConfiguration() - Method in interface com.stylusstudio.converter.Converter

Get the Configuration object for this Converter.

getConfiguration() - Method in class com.stylusstudio.converter.ConverterFactory

Get the Configuration object for this ConverterFactory.

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.

getCopy() - Method in class com.stylusstudio.converter.Configuration

-EXCLUDE- Create a copy of this Configuration object.

getCurrentDirectory() - Method in interface com.exln.stylus.io.StylusFileSystem

Retrieve the name of the last directory the user visited in a File->Open or File->Save As dialog.

getDefaultFileExtension() - Method in interface com.exln.stylus.io.StylusFileSystemOptions

Get the default file extension for this custom file system.

getEncoding() - Method in class com.stylusstudio.converter.OutputResult

Get the character encoding for a byte stream or URI.

getFactory() - Static method in class com.exln.stylus.io.StylusFileFactory

Get the singleton StylusFileFactory.

getFileClassName() - Method in interface com.exln.stylus.io.StylusFileSystem

Get the class name of the StylusFile class for this file system.

getInputStream() - Method in interface com.exln.stylus.io.StylusFile

Return a stream which can be used to read data from this StylusFile.

getInputStream() - Method in class com.stylusstudio.converter.InputStreamResult

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

getLogger() - Static method in class com.exln.stylus.io.StylusFileHelpers

Get the StylusFileHelpers.Logger object.

getMaxBufferSize() - Method in class com.stylusstudio.converter.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.

getModifiedTime() - Method in interface com.exln.stylus.io.StylusFile

Return the time that the file denoted by this StylusFile was last modified.

getName() - Method in interface com.exln.stylus.io.StylusFile

Return the file name of this StylusFile.

getName() - Method in interface com.exln.stylus.io.StylusFileSystem

Get the name of this custom file system.

getOutputStream() - Method in interface com.exln.stylus.io.StylusFile

Return an output stream which can be used to write data to this StylusFile.

getOutputStream() - Method in class com.stylusstudio.converter.OutputStreamSource

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

getPath() - Method in interface com.exln.stylus.io.StylusFile

Return the pathname of this StylusFile.

getProductName() - Static method in class com.stylusstudio.version.Version

Get the Product name for this version of the product.

getProperty(String, String) - Method in class com.stylusstudio.converter.Configuration

-EXCLUDE- For future use.

getReader() - Method in class com.stylusstudio.converter.ReaderResult

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

getResolvedPathname(String, String) - Static method in class com.exln.stylus.io.StylusFileHelpers

Resolve a uri and a baseURI to form a local filesystem pathname.

getResolvedURI(String, String) - Static method in class com.exln.stylus.io.StylusFileHelpers

Convenience routine to resolve a uri with a baseURI using the java URI class.

getRootDir() - Static method in class com.exln.stylus.io.StylusFileHelpers

Get the Stylus Studio installation directory (rootdir).

getScheme() - Method in interface com.exln.stylus.io.StylusFileSystem

Return the character string scheme name that this file system supports.

getSeparator() - Method in interface com.exln.stylus.io.StylusFileSystem

Get the separator character used to separate element names in a pathname.

getServerName() - Method in interface com.exln.stylus.io.StylusFileSystem

getSimulateTempFileFailure() - Method in class com.stylusstudio.converter.Configuration

-EXCLUDE- This method is for internal use.

getSystemId() - Method in class com.stylusstudio.converter.InputStreamResult

Get the SystemId of the result data.

getSystemId() - Method in class com.stylusstudio.converter.OutputStreamSource

-EXCLUDE- This method is not used with this class

getSystemId() - Method in class com.stylusstudio.converter.ReaderResult

Get the SystemId of the result data.

getSystemId() - Method in class com.stylusstudio.converter.WriterSource

-EXCLUDE- This method is not used with this class

getTempFilePolicy() - Method in class com.stylusstudio.converter.Configuration

Get the current value of the temp file policy.

getThreadPolicy() - Method in class com.stylusstudio.converter.Configuration

-EXCLUDE-

getURLForPathName(String) - Method in interface com.exln.stylus.io.StylusFileSystem

Return the complete URL scheme://server/pathname.

getUnlockAPIError() - Static method in class com.exln.stylus.io.StylusFileFactory

Get the error message generated from the last call to unlockAPI.

getValuesFromSystemProperties(String) - Method in class com.stylusstudio.converter.Configuration

-EXCLUDE- This method is for internal use.

getVersion() - Method in interface com.exln.stylus.io.StylusFileSystem

Get the current version number of this custom file system.

getWriter() - Method in class com.stylusstudio.converter.WriterSource

Get the Writer, which is 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.stylusstudio.converter.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.stylusstudio.converter.InputStreamResult

isAbsolute(String) - Method in interface com.exln.stylus.io.StylusFileSystem

Check whether a pathname is an absolute or relative pathname.

isDirectory() - Method in interface com.exln.stylus.io.StylusFile

Return whether the file denoted by this StylusFile is a directory.

isDirectory(String) - Method in interface com.exln.stylus.io.StylusFileSystem

Check whether a file is a directory.

isDots() - Method in interface com.exln.stylus.io.StylusFile

Return true if getName() would return "." or "..".

isFinished() - Method in interface com.stylusstudio.converter.Conversion

Return whether the Conversion has finished.

isHidden() - Method in interface com.exln.stylus.io.StylusFile

Return true if this StylusFile denotes a "Hidden" file.

isLink() - Method in interface com.exln.stylus.io.StylusFile

Return true if this StylusFile denotes a link or shortcut file.

isLocalFile(String, String) - Static method in class com.exln.stylus.io.StylusFileHelpers

Return whether the parameter represents a local file system file or directory.

isPathValid(String) - Method in interface com.exln.stylus.io.StylusFileSystem

Check whether a pathname is a valid pathname.

isReadOnly() - Method in interface com.exln.stylus.io.StylusFile

Return whether the file represented by this StylusFile is read-only.

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

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

L

length() - Method in interface com.exln.stylus.io.StylusFile

Return the number of bytes in this StylusFile.

listFiles() - Method in interface com.exln.stylus.io.StylusFile

Return an array of StylusFile objects denoting the files in the directory denoted by this StylusFile.

listRoots() - Method in interface com.exln.stylus.io.StylusFileSystem

List all the roots of the file system.

M

main(String[]) - Static method in class com.stylusstudio.version.Version

Write the product name and version to System.out

matchesScheme(String) - Method in interface com.exln.stylus.io.StylusFileSystem

Check whether this StylusFileSystem can process URLs with the specified scheme.

mkdir(String) - Method in interface com.exln.stylus.io.StylusFileSystem

Create a new directory in the file system.

N

NO_THREADS - Static variable in class com.stylusstudio.converter.Configuration

-EXCLUDE- Value for setThreadPolicy.

newConvertFromXML(String) - Method in class com.stylusstudio.converter.ConverterFactory

Create a new Converter object, using an adapter URL, to convert XML files to non-XML.

newConvertToXML(String) - Method in class com.stylusstudio.converter.ConverterFactory

Create a new Converter object, using an adapter URL, to convert non-XML files to XML.

newConvertToXML(StreamSource) - Method in class com.stylusstudio.converter.ConverterFactory

Create a new Converter object, using a .conv file, to convert non-XML files to XML.

newInstance() - Static method in class com.stylusstudio.converter.ConverterFactory

Create a new instance of the ConverterFactory.

O

OutputResult - class com.stylusstudio.converter.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.stylusstudio.converter.OutputResult

Default constructor.

OutputResult(OutputStream) - Constructor for class com.stylusstudio.converter.OutputResult

Construct an OutputResult from a byte stream (OutputStream).

OutputResult(Writer) - Constructor for class com.stylusstudio.converter.OutputResult

Construct an OutputResult from a character stream (Writer).

OutputResult(String) - Constructor for class com.stylusstudio.converter.OutputResult

Construct an OutputResult from a URI.

OutputStreamSource - class com.stylusstudio.converter.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.stylusstudio.converter.OutputStreamSource

outputStreamResolver(String, String) - Method in class com.exln.stylus.io.StylusFileFactory

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

ReaderResult - class com.stylusstudio.converter.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.stylusstudio.converter.ReaderResult

refreshValuesFromSystemProperties(String) - Method in class com.stylusstudio.converter.Configuration

-EXCLUDE- Internal use only, please.

registerScheme(String, String) - Method in class com.exln.stylus.io.StylusFileFactory

Register a scheme name and its associated StylusFile class name.

registerScheme(String, String, String) - Method in class com.exln.stylus.io.StylusFileFactory

Register a scheme name and its associated StylusFile class name and classpath.

renameTo(String, String) - Method in interface com.exln.stylus.io.StylusFileSystem

Rename an existing directory in the file system.

resolve(String, String) - Method in class com.exln.stylus.io.StylusFileFactory.ResolverWrapper

Implements the URIResolver interface by passing the call on to the singleton StylusFileFactory.

resolve(String, String) - Method in class com.exln.stylus.io.StylusFileFactory

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

resolve(String, String) - Static method in class com.exln.stylus.io.StylusFileHelpers

Resolve a URI with a base URI.

resolveEntity(String, String) - Method in class com.exln.stylus.io.StylusFileFactory

Implementation of EntityResolver.

resolveShortcuts(String) - Method in interface com.exln.stylus.io.StylusFileSystem

Return the target pathname of a shortcut or link.

S

SAXConversion - interface com.stylusstudio.converter.SAXConversion.

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

StylusFile - interface com.exln.stylus.io.StylusFile.

An abstract representation of a file in a custom file system.

StylusFileFactory - class com.exln.stylus.io.StylusFileFactory.

Defines a factory API that enables applications to read and write data streams using any custom file system which implements the StylusFile interface.

StylusFileFactory.ResolverWrapper - class com.exln.stylus.io.StylusFileFactory.ResolverWrapper.

Wraps the singleton StylusFileFactory object in a class which can be instantiated with a constructor.

StylusFileFactory.ResolverWrapper() - Constructor for class com.exln.stylus.io.StylusFileFactory.ResolverWrapper

Default constructor returns an object which references the singleton StylusFileFactory.

StylusFileHelpers - class com.exln.stylus.io.StylusFileHelpers.

A collection of static helpers for use with the Stylus Studio custom file system interfaces StylusFile and StylusFileSystem and the class StylusFileFactory.

StylusFileSystem - interface com.exln.stylus.io.StylusFileSystem.

Represents a custom file system.

StylusFileSystemOptions - interface com.exln.stylus.io.StylusFileSystemOptions.

Optional methods for a Stylus Studio custom file system.

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.stylusstudio.converter.Configuration

Set the memory buffer overflow policy.

setCurrentDirectory(String) - Method in interface com.exln.stylus.io.StylusFileSystem

Store the name of the last directory the user visited in a File->Open or File->Save As dialog.

setEncoding(String) - Method in class com.stylusstudio.converter.OutputResult

Set the character encoding, if known.

setInputStream(InputStream) - Method in class com.stylusstudio.converter.InputStreamResult

-EXCLUDE- Set the InputStream which contains the result data.

setMaxBufferSize(int) - Method in class com.stylusstudio.converter.Configuration

Set the maximum size limit for the memory buffer.

setOutputStream(OutputStream) - Method in class com.stylusstudio.converter.OutputStreamSource

-EXCLUDE- Set the OutputStream to which source data may be written.

setProperty(String, String) - Method in class com.stylusstudio.converter.Configuration

-EXCLUDE- For future use.

setReader(Reader) - Method in class com.stylusstudio.converter.ReaderResult

-EXCLUDE- Set the Reader which contains the result data.

setSystemId(String) - Method in class com.stylusstudio.converter.InputStreamResult

-EXCLUDE- Set the SystemId of the result data.

setSystemId(String) - Method in class com.stylusstudio.converter.OutputStreamSource

-EXCLUDE- This method is not used with this class

setSystemId(String) - Method in class com.stylusstudio.converter.ReaderResult

-EXCLUDE- Set the SystemId of the result data.

setSystemId(String) - Method in class com.stylusstudio.converter.WriterSource

-EXCLUDE- This method is not used with this class

setTempFilePolicy(int) - Method in class com.stylusstudio.converter.Configuration

Get the temp file policy.

setThreadPolicy(int) - Method in class com.stylusstudio.converter.Configuration

-EXCLUDE-

setWriter(Writer) - Method in class com.stylusstudio.converter.WriterSource

-EXCLUDE- Set the Writer to which source data may be written.

stripFile(String) - Static method in class com.exln.stylus.io.StylusFileHelpers

Remove a file:/// prefix from a URL to create a pathname.

supportServer() - Method in interface com.exln.stylus.io.StylusFileSystem

supportsCaseSensitivePathNames() - Method in interface com.exln.stylus.io.StylusFileSystemOptions

Return whether pathnames in this custom file system are case sensitive.

supportsDelete() - Method in interface com.exln.stylus.io.StylusFileSystemOptions

Return whether this custom file system can delete files.

supportsDirectories() - Method in interface com.exln.stylus.io.StylusFileSystem

Check whether this custom file system is modeled as a tree or is flat.

T

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

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

TO_XML - Static variable in interface com.stylusstudio.converter.Converter

-EXCLUDE-

TRY_THREAD - Static variable in class com.stylusstudio.converter.Configuration

-EXCLUDE- Value for setThreadPolicy.

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.stylusstudio.converter.Configuration

Value for setMaxBufferSize to indicate there should be no limit.

USE_MEMORY - Static variable in class com.stylusstudio.converter.Configuration

Value for setTempFilePolicy.

USE_TEMP_FILE - Static variable in class com.stylusstudio.converter.Configuration

Value for setBufferOverflowPolicy.

unlockAPI(String) - Static method in class com.exln.stylus.io.StylusFileFactory

Unlock the StylusFileFactory API.

unlockObject(Object) - Static method in class com.exln.stylus.io.StylusFileFactory

V

Version - class com.stylusstudio.version.Version.

A class containing version identification information.

W

WriterSource - class com.stylusstudio.converter.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.stylusstudio.converter.WriterSource

X

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

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

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