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

A

addPath(String) - Method in class ru.novosoft.dc.rtf_to_xml.ConversionTask

Add a new path to the path list of converted files.

ALREADY_PREPARED - Static variable in interface ru.novosoft.dc.core.PicturePool

The action type is "skip the picture" because such a picture is already prepared.

appendExtension(String, String) - Static method in class ru.novosoft.dc.core.IOService

Append the specified extension to the path, if the path just not has this extension yet, and return the result.

B

BMP - Static variable in interface ru.novosoft.dc.core.PictureType

The Windows device-dependent bitmap type.

C

clearError() - Method in interface ru.novosoft.dc.core.CommonLogger

Clear error tag.

close() - Method in interface ru.novosoft.dc.core.CommonLogger

Close the logger.

closeOut(OutputStream) - Static method in class ru.novosoft.dc.core.IOService

Close the output stream and catch the IOException.

CommonLogger - interface ru.novosoft.dc.core.CommonLogger.

This interface joins features of Logger and SystemLogger and adds more functionality.

configPath() - Method in class ru.novosoft.dc.core.NSDCContext

Return the canonical path to the converter's configuration directory.

context() - Method in class ru.novosoft.dc.rtf_to_xml.ConversionTask

Return the context of this task.

ConversionHandler - interface ru.novosoft.dc.core.ConversionHandler.

The interface provides methods for handling a document conversion.

ConversionTask - class ru.novosoft.dc.rtf_to_xml.ConversionTask.

An instance of this class provides preparation and execution of an RTF_TO_XML conversion task.

ConversionTask(PrintStream) - Constructor for class ru.novosoft.dc.rtf_to_xml.ConversionTask

Create a new conversion task.

Convert - class ru.novosoft.dc.rtf_to_xml.Convert.

RTF_TO_XML command line interface implementation.

convert() - Method in class ru.novosoft.dc.rtf_to_xml.ConversionTask

Execute the task specified in this object and return true if the conversion has finished without errors.

convert(InputStream, RTF_TO_XMLContext, CommonLogger, PicturePool, DOMImplementation) - Static method in class ru.novosoft.dc.rtf_to_xml.RTF_TO_XML

Convert the specified input file to FO using the specified context, logger, and picture pool.

convert(PictureHandler, String, boolean) - Method in interface ru.novosoft.dc.core.PictureConverter

Try to convert a picture and return true if a conversion successful.

convert(String, boolean) - Static method in class ru.novosoft.dc.rtf_to_xml.RTF_TO_XML

Convert the specified RTF file to FO using the default configuration settings.

convert(String, int, boolean) - Static method in class ru.novosoft.dc.rtf_to_xml.RTF_TO_XML

Convert the specified RTF file to FO using the default configuration settings and the specified logging level.

convert(String, RTF_TO_XMLContext, boolean) - Static method in class ru.novosoft.dc.rtf_to_xml.RTF_TO_XML

Convert the specified RTF file to FO using the specified context and logging to the default logger of the context.

convert(String, String, RTF_TO_XMLContext, CommonLogger, ConversionHandler, boolean) - Static method in class ru.novosoft.dc.rtf_to_xml.RTF_TO_XML

Convert the specified RTF file to FO using the specified context and logger.

convert(String, String, RTF_TO_XMLContext, CommonLogger, ConversionHandler, PicturePool, boolean) - Static method in class ru.novosoft.dc.rtf_to_xml.RTF_TO_XML

Convert the specified RTF file to FO using the specified context, logger, and picture pool.

createDirectory(String) - Static method in class ru.novosoft.dc.core.IOService

Try to create a directory with the specified path and return true if the directory already exists or the creation was successful.

createPath(String, String) - Static method in class ru.novosoft.dc.core.IOService

Create a new path by replacing the extension of the specified path to the specified extension.

CROP_BOTTOM - Static variable in interface ru.novosoft.dc.core.PictureInfo

The index of "picture crop in twips from bottom" parameter.

CROP_LEFT - Static variable in interface ru.novosoft.dc.core.PictureInfo

The index of "picture crop in twips from left" parameter.

CROP_RIGHT - Static variable in interface ru.novosoft.dc.core.PictureInfo

The index of "picture crop in twips from right" parameter.

CROP_TOP - Static variable in interface ru.novosoft.dc.core.PictureInfo

The index of "picture crop in twips from top" parameter.

D

dataPath() - Method in class ru.novosoft.dc.core.NSDCContext

Return the canonical path to the converter's data directory.

debug(String) - Method in interface ru.novosoft.dc.core.CommonLogger

Send a debug message to the logger.

debug(Throwable) - Method in interface ru.novosoft.dc.core.CommonLogger

Send the stack trace of the specified throwable object to the logger as a debug message.

defaultModel() - Method in class ru.novosoft.dc.rtf_to_xml.RTF_TO_XMLContext

Return the name of default model or empty string if the default model is undefined.

DIB - Static variable in interface ru.novosoft.dc.core.PictureType

The Windows device-independent bitmap type.

E

EMF - Static variable in interface ru.novosoft.dc.core.PictureType

The enhanced metafile type.

errorsWereLogged() - Method in interface ru.novosoft.dc.core.CommonLogger

Return true if an error message was sent to the logger.

F

findConfigFile(String, String) - Method in class ru.novosoft.dc.core.NSDCContext

Find a file with the specified filename and return its canonical path.

findFile(String) - Static method in class ru.novosoft.dc.core.IOService

Try to find a file at the specified path.

findFile(String, String) - Static method in class ru.novosoft.dc.core.IOService

Try to find a file at the specified path by the following algorithm: If the path starts with "file:" or "file:/" protocol, the protocol is removed and the file is searched as is.

findFileInResources(String) - Static method in class ru.novosoft.dc.core.IOService

Try to find a file in resources (in path list specified in the Java classpath variable) and return the canonical path to it or null if search fails.

findHomePath(String) - Static method in class ru.novosoft.dc.core.IOService

Find a home path using a value of system property with the specified propertyName name and return it.

finishProcessing(PictureHandler, OutputStream, boolean) - Method in interface ru.novosoft.dc.core.PicturePool

Complete processing of the picture.

freezeCoreOptions() - Method in class ru.novosoft.dc.core.NSDCContext

Freeze core options against changes.

FULL_LOG - Static variable in class ru.novosoft.dc.core.NSDCContext

This log level means logging of all messages to files and to the system log (debug messages and messages on unknown rtf-commands are logged to files only).

FULL_SILENT_LOG - Static variable in class ru.novosoft.dc.core.NSDCContext

This log level means logging of all messages to files.

fullString() - Method in class ru.novosoft.dc.core.StringEnumeration

Return the last matching string found (it is recommended to use this method after successful call of StringEnumeration.hasMoreMatchingStrings() or StringEnumeration.nextTrimmedString() methods).

G

get(int) - Method in interface ru.novosoft.dc.core.PictureHandler

Get the value of the picture parameter of the specified index (meaning of indices specified in PictureInfo).

getContext() - Method in interface ru.novosoft.dc.core.PictureHandler

Return a picture context for testing on uniqueness.

getDefaultLogger() - Method in class ru.novosoft.dc.core.NSDCContext

Return the default logger.

getDOMImplementation() - Method in class ru.novosoft.dc.core.NSDCHandler

Return an implementation of Document Object Model.

getDOMImplementation() - Method in interface ru.novosoft.dc.core.ConversionHandler

Return an implementation of Document Object Model.

getDouble(String, double) - Method in class ru.novosoft.dc.core.NSDCContext

Return a double value of the option with the specified name or the default value if this option undefined or contains non-double value.

getFileExtension(String, String) - Method in class ru.novosoft.dc.core.NSDCContext

Get an option value and test it to be a valid file extension, which starts from the decimal point and contains alphanumeric symbols after it (ASCII only).

getFloat(String, float) - Method in class ru.novosoft.dc.core.NSDCContext

Return a float value of the option with the specified name or the default value if this option undefined or contains non-float value.

getInt(String, int) - Method in class ru.novosoft.dc.core.NSDCContext

Return an integer value of the option with the specified name or the default value if this option undefined or contains non-integer value.

getNonemptyOption(String) - Method in class ru.novosoft.dc.core.NSDCContext

Return an option value if it is specified and is a nonempty string.

getOption(String) - Method in class ru.novosoft.dc.core.NSDCContext

Return a value of option with the specified name or null if this option undefined.

getOption(String, String) - Method in class ru.novosoft.dc.core.NSDCContext

Return a value of option with the specified name or the default value if this option undefined.

getOptionAsPath(String) - Method in class ru.novosoft.dc.core.NSDCContext

Get a value of option with the specified name and find the path using the IOService.findFile method with the home path and the value of this option passed in parameters.

getPictureID() - Method in interface ru.novosoft.dc.core.PictureHandler

Return a picture ID or null if no ID defined yet.

getPictureType() - Method in interface ru.novosoft.dc.core.PictureHandler

Return a type of the picture handled.

getSpecifiedOption(String) - Method in class ru.novosoft.dc.core.NSDCContext

Get an option value and ensure that it is not null, i.e. the option is specified.

getSystemLog() - Method in interface ru.novosoft.dc.core.CommonLogger

Return the system log attached or null if the system log undefined.

getUniqueTag() - Method in interface ru.novosoft.dc.core.PictureHandler

Return a unique tag of the picture or 0 if the tag unspecified.

getURL() - Method in interface ru.novosoft.dc.core.PictureHandler

Return the URL of the picture or null if it is undefined.

getUserPreferencesPath() - Method in class ru.novosoft.dc.core.NSDCContext

Return a name of file of user preferences.

getUserPreferencesPath() - Method in class ru.novosoft.dc.rtf_to_xml.RTF_TO_XMLContext

Return a path to the user preferences file.

H

hasMoreMatchingStrings() - Method in class ru.novosoft.dc.core.StringEnumeration

Test the inner enumeration to contain a matching string and return true if such a string found.

HEIGHT - Static variable in interface ru.novosoft.dc.core.PictureInfo

The index of "picture height in twips" parameter.

homePath() - Method in class ru.novosoft.dc.core.NSDCContext

Return the canonical path to the converter's home directory.

I

INFO_LOG - Static variable in class ru.novosoft.dc.core.NSDCContext

This log level means logging of information messages to the system log.

info(String) - Method in class ru.novosoft.dc.core.NSDCContext

Send the message to the default logger.

info(String) - Method in interface ru.novosoft.dc.core.PictureHandler

Send an information message to the logger of this handler.

IOService - class ru.novosoft.dc.core.IOService.

The class contains miscellaneous static I/O service methods.

isactive1() - Method in interface ru.novosoft.dc.core.PictureConverter

Return true if the converter is active1.

isTrue(String) - Method in class ru.novosoft.dc.core.NSDCContext

Return true if and only if the option with specified name is defined and its value is equal to "true".

J

JPEG - Static variable in interface ru.novosoft.dc.core.PictureType

The JPEG type.

L

loadConfiguration(String, String) - Static method in class ru.novosoft.dc.core.NSDCContext

Load configuration properties from the specified file and return them.

loadOptions(String) - Method in class ru.novosoft.dc.core.NSDCContext

Load options from file.

loadPropertiesFrom(File) - Static method in class ru.novosoft.dc.core.IOService

Try to load properties from a specified file.

loadPropertiesFrom(InputStream) - Static method in class ru.novosoft.dc.core.IOService

Try to load properties from a specified stream.

loadPropertiesFrom(String) - Static method in class ru.novosoft.dc.core.IOService

Try to load properties from file at the specified path.

loadUserPreferences() - Method in class ru.novosoft.dc.core.NSDCContext

Load user preference options from the file of user preferences (returned by NSDCContext.getUserPreferencesPath()).

loadUserPreferences(Properties) - Method in class ru.novosoft.dc.core.NSDCContext

Load user preference options from a specified set of properties.

Logger - interface ru.novosoft.dc.core.Logger.

This interface is used for logging messages of different kinds.

logOption(CommonLogger, String) - Method in class ru.novosoft.dc.core.NSDCContext

Log an option to the logger if it is specified.

logOption(CommonLogger, String, String) - Static method in class ru.novosoft.dc.core.NSDCContext

Log an option to the logger if it has a non-null value.

logOptionIfNonempty(CommonLogger, String) - Method in class ru.novosoft.dc.core.NSDCContext

Log an option to the logger if its value is nonempty string.

logOptionIfTrue(CommonLogger, String) - Method in class ru.novosoft.dc.core.NSDCContext

Log an option to the logger if its value is equal to "true".

logOptions(CommonLogger) - Method in class ru.novosoft.dc.core.NSDCContext

The method is designed for logging options to the specified logger just before a conversion.

logOptions(CommonLogger) - Method in class ru.novosoft.dc.rtf_to_xml.RTF_TO_XMLContext

Logging of user-defined options to the specified logger.

logPath(String) - Method in class ru.novosoft.dc.core.NSDCContext

Return the log path specified by the logDirectoryPath and the "log-name" option.

M

main(String[]) - Static method in class ru.novosoft.dc.rtf_to_xml.Convert

RTF_TO_XML command line call.

MET - Static variable in interface ru.novosoft.dc.core.PictureType

The OS/2 metafile type.

models() - Method in class ru.novosoft.dc.rtf_to_xml.RTF_TO_XMLContext

Return an array of valid models sorted alphabetically except the default model stored as the last model in the array.

N

newLogger(String, int) - Method in class ru.novosoft.dc.core.NSDCContext

Construct a new logger of the specified log-level and return it.

newLogger(String, int) - Method in class ru.novosoft.dc.rtf_to_xml.RTF_TO_XMLContext

Construct a new logger of the specified log-level and return it.

newPictureConverter() - Method in class ru.novosoft.dc.rtf_to_xml.RTF_TO_XMLContext

Return null or a new picture converter to be attached to this instance.

newPicturePool(String, boolean) - Method in class ru.novosoft.dc.core.NSDCContext

Construct a new picture pool using the specified path as a parent name for pictures.

newPicturePool(String, boolean) - Method in class ru.novosoft.dc.rtf_to_xml.RTF_TO_XMLContext

Construct a new picture pool using the specified path as a parent name for pictures: all pictures will be stored in the subdirectory created from the path and the extension ".images".

newProcessLogger(String, InputStream) - Method in interface ru.novosoft.dc.core.ProcessLoggerFactory

Return a new process logging thread marked with the specified title.

nextTrimmedString() - Method in class ru.novosoft.dc.core.StringEnumeration

Extract the next matching string, trim its prefix, and return the result.

NO_LOG - Static variable in class ru.novosoft.dc.core.NSDCContext

This log level means no logging at all.

NORMAL_LOG - Static variable in class ru.novosoft.dc.core.NSDCContext

This log level means logging of all except debug messages to a file and to the system log.

NSDC_PROPERTIES - Static variable in class ru.novosoft.dc.core.NSDCContext

The default path of the file of converter's properties.

NSDCContext - class ru.novosoft.dc.core.NSDCContext.

The core context for a converter of rtf-file.

NSDCContext(String, Properties, PrintStream, String[]) - Constructor for class ru.novosoft.dc.core.NSDCContext

Construct an instance of the context, create a default logger of the INFO_LOG logging level, and register the specified properties.

NSDCException - exception ru.novosoft.dc.core.NSDCException.

The exception is thrown if something wrong while preparing an instance of a converter class.

NSDCException() - Constructor for class ru.novosoft.dc.core.NSDCException

NSDCException(String) - Constructor for class ru.novosoft.dc.core.NSDCException

NSDCHandler - class ru.novosoft.dc.core.NSDCHandler.

The class provides methods for handling a document conversion using Apache Xerces2 DOM implementation and XML serializer.

NSDCHandler(NSDCContext) - Constructor for class ru.novosoft.dc.core.NSDCHandler

Construct a serializer based on the specified context.

O

openForWriting(String) - Static method in class ru.novosoft.dc.core.IOService

Try to open a file in the specified path for writing with creating of all parent directories if necessary.

OptionProcessor - interface ru.novosoft.dc.core.OptionProcessor.

A processor of options interface.

options() - Method in class ru.novosoft.dc.core.NSDCContext

Return all options specified.

outputWithIndents() - Method in class ru.novosoft.dc.rtf_to_xml.ConversionTask

Switch on the indented output to XML.

P

parseOption(String) - Method in class ru.novosoft.dc.core.NSDCContext

Parse a string having the form "key:value" and call the setOption(key, value) method.

PICT - Static variable in interface ru.novosoft.dc.core.PictureType

The QuickDraw type.

PictureConverter - interface ru.novosoft.dc.core.PictureConverter.

A picture converter interface.

pictureConverter() - Method in class ru.novosoft.dc.rtf_to_xml.RTF_TO_XMLContext

Return a picture converter attached to this instance.

PictureHandler - interface ru.novosoft.dc.core.PictureHandler.

A picture handler provides logging and access to the picture information.

PictureInfo - interface ru.novosoft.dc.core.PictureInfo.

Indices of picture information parameters.

PicturePool - interface ru.novosoft.dc.core.PicturePool.

A picture pool appoints streams for writing pictures and provides the post-processing of pictures.

PictureType - interface ru.novosoft.dc.core.PictureType.

Types of rtf-pictures.

pictureWasChanged() - Method in interface ru.novosoft.dc.core.PictureHandler

Send a signal to the handler that a picture size or type was changed.

pluginExtension() - Method in class ru.novosoft.dc.core.NSDCContext

Return the extension for plugin configuration files.

pluginPath() - Method in class ru.novosoft.dc.core.NSDCContext

Return the canonical path to the plugin's directory.

PNG - Static variable in interface ru.novosoft.dc.core.PictureType

The PNG type.

prepareContext(PrintStream) - Static method in class ru.novosoft.dc.rtf_to_xml.RTF_TO_XMLContext

Prepare the RTF_TO_XML context loading its properties from the file specified in the "rtf_to_xml.configuration" system property.

PROCESS - Static variable in interface ru.novosoft.dc.core.PicturePool

The action type is "process the picture".

ProcessLoggerFactory - interface ru.novosoft.dc.core.ProcessLoggerFactory.

A factory of process loggers.

processOption(String, String) - Method in interface ru.novosoft.dc.core.OptionProcessor

Process an option.

R

removeFileProtocol(String) - Static method in class ru.novosoft.dc.core.IOService

Test a path to start with the "file:" protocol and remove it from the path name.

removeFileProtocol(String, boolean) - Static method in class ru.novosoft.dc.core.IOService

Test a path to start with the "file:" protocol and remove it from the path name.

requiredAction(PictureHandler) - Method in interface ru.novosoft.dc.core.PicturePool

Analyze the picture and select an action required.

RTF_TO_XML - class ru.novosoft.dc.rtf_to_xml.RTF_TO_XML.

The class contains a number of static service methods for convertion from RTF to FO.

RTF_TO_XMLContext - class ru.novosoft.dc.rtf_to_xml.RTF_TO_XMLContext.

An extension of the NSDCContext is intended for the management of RTF_TO_XML conversion.

RTF_TO_XMLContext(String, Properties, PrintStream) - Constructor for class ru.novosoft.dc.rtf_to_xml.RTF_TO_XMLContext

Construct an instance of the context, create a default logger of the logging level INFO_LOG, and register the specified properties.

ru.novosoft.dc.core - package ru.novosoft.dc.core

ru.novosoft.dc.rtf_to_xml - package ru.novosoft.dc.rtf_to_xml

S

SCALE_X - Static variable in interface ru.novosoft.dc.core.PictureInfo

The index of "picture horizontal scale in percent" parameter.

SCALE_Y - Static variable in interface ru.novosoft.dc.core.PictureInfo

The index of "picture vertical scale in percent" parameter.

sendMessage(int, String) - Method in interface ru.novosoft.dc.core.Logger

Sends a message of the specified kind to the logger.

sendMessage(String) - Method in interface ru.novosoft.dc.core.SystemLogger

Send a non-categorized message to the system log and main log.

sendSilentMessage(String) - Method in interface ru.novosoft.dc.core.SystemLogger

Send a non-categorized message to the main log.

serialize(Document, CommonLogger, String, String, boolean, boolean, int) - Method in class ru.novosoft.dc.core.NSDCHandler

Serialize the document to XML file constructing its name from the fileName parameter and the specified extension.

serialize(Document, CommonLogger, String, String, boolean, boolean, int) - Method in interface ru.novosoft.dc.core.ConversionHandler

Serialize the document to a file constructing its name from the fileName parameter and the specified extension.

set(int, int) - Method in interface ru.novosoft.dc.core.PictureHandler

Set a value for the picture parameter of the specified index (meaning of indices specified in PictureInfo).

setDefaultLogger(CommonLogger) - Method in class ru.novosoft.dc.core.NSDCContext

Set the default logger.

setDestinationPath(String) - Method in class ru.novosoft.dc.rtf_to_xml.ConversionTask

Set a destination path for the task.

setLogLevel(int) - Method in class ru.novosoft.dc.rtf_to_xml.ConversionTask

Set a logging level for the task.

setOption(String, String) - Method in class ru.novosoft.dc.core.NSDCContext

Set an individual converter's option.

setOptionProcessor(String, OptionProcessor) - Method in class ru.novosoft.dc.core.NSDCContext

Set a processor for the specified option name.

setOptions(Properties, String) - Method in class ru.novosoft.dc.core.NSDCContext

Set options using only those properties of the passed properties' table which start from the specified prefix.

setPictureID(Object) - Method in interface ru.novosoft.dc.core.PictureHandler

Set a picture ID.

setSourcePath(String) - Method in class ru.novosoft.dc.rtf_to_xml.ConversionTask

Set a source path for the task.

setSystemProperties(Properties) - Static method in class ru.novosoft.dc.core.StringEnumeration

Extract properties starting with "system." prefix from the input parameter, removes the prefix from their names, test them to be unspecified as system properties, and set them if the testing successful.

setURL(URL) - Method in interface ru.novosoft.dc.core.PictureHandler

Set a new URL for the picture.

SILENT_LOG - Static variable in class ru.novosoft.dc.core.NSDCContext

This log level means logging of all except debug messages to a file.

SKIP - Static variable in interface ru.novosoft.dc.core.PicturePool

The action type is "skip the picture" (the pool cannot process this type of picture).

skipExistingFiles() - Method in class ru.novosoft.dc.rtf_to_xml.ConversionTask

Switch on the skip-existing-files mode.

start(String, CommonLogger) - Method in class ru.novosoft.dc.core.NSDCHandler

Open a source file for reading, log a message on starting conversion, and return the input stream opened.

start(String, CommonLogger) - Method in interface ru.novosoft.dc.core.ConversionHandler

Open a source file for reading, log a message on starting conversion, and return the input stream opened.

startProcessing(PictureHandler) - Method in interface ru.novosoft.dc.core.PicturePool

Start processing of a picture.

stopOnErrors() - Method in class ru.novosoft.dc.rtf_to_xml.ConversionTask

Switch on the error-stop mode.

StringEnumeration - class ru.novosoft.dc.core.StringEnumeration.

The string enumeration filters objects and returns those of them, which match the following conditions: are String instances and start with the specified prefix.

StringEnumeration(Enumeration, String) - Constructor for class ru.novosoft.dc.core.StringEnumeration

Constructor.

systemLog() - Method in class ru.novosoft.dc.core.NSDCContext

Return a system log specified for this context.

SystemLogger - interface ru.novosoft.dc.core.SystemLogger.

This interface is used for logging of noncategorized messages to system and main logs.

T

TRY_ANOTHER - Static variable in interface ru.novosoft.dc.core.PicturePool

The action type is "try to skip the picture" (use an alternative if possible but process this picture if no alternative exist).

U

unlikedPictureType(int) - Method in interface ru.novosoft.dc.core.PicturePool

Set the specified picture type (a type constant from the PictureType interface) to be unliked.

useRecursion() - Method in class ru.novosoft.dc.rtf_to_xml.ConversionTask

Switch on the recursive conversion in subdirectories.

V

validateOptions() - Method in class ru.novosoft.dc.core.NSDCContext

Validate setting of options and return true if the validation is successful.

validateOptions() - Method in class ru.novosoft.dc.rtf_to_xml.RTF_TO_XMLContext

Validate the correctness of the "model" selection and return true if the validation is successful.

VERSION - Static variable in class ru.novosoft.dc.rtf_to_xml.Convert

A version of RTF_TO_XML.

W

warning(String) - Method in interface ru.novosoft.dc.core.PictureHandler

Send a warning message to the logger of this handler.

WIDTH - Static variable in interface ru.novosoft.dc.core.PictureInfo

The index of "picture width in twips" parameter.

WMF - Static variable in interface ru.novosoft.dc.core.PictureType

The Windows metafile type.

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