A B C D E F G H I K L M N P R S T

A

ADD_INDEX - Static variable in class com.docmosis.demo.web.AnalysisFormRenderer

AlternatingTableRowRenderer - class com.docmosis.template.population.render.AlternatingTableRowRenderer.

This class renders alternating rows of a table in the two colours specified at construction.

AlternatingTableRowRenderer() - Constructor for class com.docmosis.template.population.render.AlternatingTableRowRenderer

Construct a new alternating row renderer that alternates white then light grey.

AlternatingTableRowRenderer(String, String) - Constructor for class com.docmosis.template.population.render.AlternatingTableRowRenderer

Construct a new renderer that alternates between the specified colours.

AnalysisFormRenderer - class com.docmosis.demo.web.AnalysisFormRenderer.

AnalysisFormRenderer(String) - Constructor for class com.docmosis.demo.web.AnalysisFormRenderer

add(DataProvider, String) - Method in class com.docmosis.template.population.DataProviderBuilder

Add the given data provider to our current data under the given key.

add(String, String) - Method in class com.docmosis.template.population.DataProviderBuilder

Add a new key-value pair to the current data.

add(String[]) - Method in class com.docmosis.template.population.DataProviderBuilder

Add a key value pair to the memory data provider.

addAll(String[][]) - Method in class com.docmosis.template.population.DataProviderBuilder

Add all key value pairs to the memory data provider.

addAll(Map) - Method in class com.docmosis.template.population.DataProviderBuilder

Add all key value pairs from a map to the memory data provider.

addDataObject(Object) - Method in class com.docmosis.template.population.CompoundDataProvider

Add an arbitrary object as a data provider to this compound provider.

addDataObject(Object, boolean) - Method in class com.docmosis.template.population.CompoundDataProvider

Add an arbitrary object as a data provider to this compound provider.

addDataProvider(DataProvider) - Method in class com.docmosis.template.population.CompoundDataProvider

Add a data provider to this compound provider.

addDataProvider(String, DataProvider) - Method in class com.docmosis.template.population.MemoryDataProvider

Add a data provider of the given key at the next available index.

addDataProvider(String, DataProvider) - Method in interface com.docmosis.template.population.MutableDataProvider

addDataProvider(String, DataProvider) - Method in class com.docmosis.template.population.NestingDataProvider

addDataProvider(String, DataProvider, MutableDataProvider, MutableDataProviderFactory) - Static method in class com.docmosis.template.population.NestingDataProvider

addDataProviders(DataProvider[]) - Method in class com.docmosis.template.population.CompoundDataProvider

Add an array of DataProviders to this compound provider.

addDataProviders(List) - Method in class com.docmosis.template.population.CompoundDataProvider

Add a List of arbitrary objects as data providers to this compound provider.

addFile(File) - Method in class com.docmosis.template.population.DataProviderBuilder

Add a key-value pair file that using a comma as a delimiter.

addFile(File, char) - Method in class com.docmosis.template.population.DataProviderBuilder

Add a key-value pair file using the given delimiter to distinguish key from value.

addFile(File, char, String) - Method in class com.docmosis.template.population.DataProviderBuilder

Add a key-value pair file using the given delimiter to distinguish key from value.

addImage(String, File) - Method in class com.docmosis.template.population.DataProviderBuilder

Add the given image (in a file) to the current data

addImage(String, InputStream) - Method in class com.docmosis.template.population.DataProviderBuilder

Add the given image (in an InputStream) to the current data

addJavaObject(Object) - Method in class com.docmosis.template.population.DataProviderBuilder

Add a Java object to the "top level" of our data.

addJavaObject(Object, String) - Method in class com.docmosis.template.population.DataProviderBuilder

Add the given Java object to our current data so that it may be referenced by the given key.

addSQL(ResultSet, String) - Method in class com.docmosis.template.population.DataProviderBuilder

Add the given ResultSet to our data.

addSQL(ResultSet, DataProviderGrouping[]) - Method in class com.docmosis.template.population.DataProviderBuilder

Add the given ResultSet to our data using the given grouping definition to transform the ResultSet grid into a hierarchy.

addToDataProvider(SQLDataProvider, ResultSet, String) - Static method in class com.docmosis.template.population.DataProviderFactory

Alter a simple data provider by adding data based on a given SQL result set.

addToDataProvider(SQLDataProvider, ResultSet, DataProviderGrouping[]) - Static method in class com.docmosis.template.population.DataProviderFactory

Alter a hierarchical data provider by adding data based on a given SQL result set.

B

BOOLEAN_DINGBATS_TICK_CROSS_DATA_FORMATTER - Static variable in class com.docmosis.template.population.format.BooleanDataFormatter

A Convenience DataFormatter that will render Dingbats tick and cross values for booleans.

BOOLEAN_WINGDINGS_TICK_CROSS_BOX_DATA_FORMATTER - Static variable in class com.docmosis.template.population.format.BooleanDataFormatter

A Convenience DataFormatter that will render WingDings tick, cross and empty box values for Booleans.

BOOLEAN_WINGDINGS_TICK_CROSS_DATA_FORMATTER - Static variable in class com.docmosis.template.population.format.BooleanDataFormatter

A Convenience DataFormatter that will render WingDings tick and cross values for booleans.

BOOLEAN_YES_NO_DATA_FORMATTER - Static variable in class com.docmosis.template.population.format.BooleanDataFormatter

A Convenience DataFormatter that will render YES, NO values for booleans.

BOOLEAN_Y_N_DATA_FORMATTER - Static variable in class com.docmosis.template.population.format.BooleanDataFormatter

A Convenience DataFormatter that will render Y, N values for booleans.

BOOLEAN_Yes_No_DATA_FORMATTER - Static variable in class com.docmosis.template.population.format.BooleanDataFormatter

A Convenience DataFormatter that will render Yes, No values for booleans.

BOOLEAN_yes_no_DATA_FORMATTER - Static variable in class com.docmosis.template.population.format.BooleanDataFormatter

A Convenience DataFormatter that will render yes, no values for booleans.

BooleanDataFormatter - class com.docmosis.template.population.format.BooleanDataFormatter.

A Convenience DataFormatter that will render String values for booleans.

BooleanDataFormatter(String, String) - Constructor for class com.docmosis.template.population.format.BooleanDataFormatter

BooleanDataFormatter(String, String, String) - Constructor for class com.docmosis.template.population.format.BooleanDataFormatter

BooleanRenderer - class com.docmosis.template.population.render.BooleanRenderer.

A Boolean Renderer that supports a single parameter specifying the way to render the boolean.

BooleanRenderer() - Constructor for class com.docmosis.template.population.render.BooleanRenderer

C

CROSS2_DINGBATS - Static variable in class com.docmosis.document.CharacterConstants

CROSS3_DINGBATS - Static variable in class com.docmosis.document.CharacterConstants

CROSS4_DINGBATS - Static variable in class com.docmosis.document.CharacterConstants

CROSS_BOXED_WINGDINGS - Static variable in class com.docmosis.document.CharacterConstants

CROSS_DINGBATS - Static variable in class com.docmosis.document.CharacterConstants

CROSS_WINGDINGS - Static variable in class com.docmosis.document.CharacterConstants

CharacterConstants - class com.docmosis.document.CharacterConstants.

Constants in this class are helpful for inserting special characters into documents.

CharacterConstants() - Constructor for class com.docmosis.document.CharacterConstants

Cleanable - interface com.docmosis.template.population.Cleanable.

Identify an Object that may be cleaned up.

CompoundDataProvider - class com.docmosis.template.population.CompoundDataProvider.

A DataProvider that provides a "chain" of data providers.

CompoundDataProvider() - Constructor for class com.docmosis.template.population.CompoundDataProvider

ConversionException - exception com.docmosis.document.converter.ConversionException.

ConversionException() - Constructor for class com.docmosis.document.converter.ConversionException

ConversionException(String) - Constructor for class com.docmosis.document.converter.ConversionException

ConversionException(String, Throwable) - Constructor for class com.docmosis.document.converter.ConversionException

ConversionException(Throwable) - Constructor for class com.docmosis.document.converter.ConversionException

ConversionFormat - class com.docmosis.document.converter.ConversionFormat.

This class specifies the available target formats for document production.

ConversionInstruction - class com.docmosis.document.converter.ConversionInstruction.

This class is used to specify various settings for a document to be rendered.

ConversionInstruction() - Constructor for class com.docmosis.document.converter.ConversionInstruction

ConverterPoolException - exception com.docmosis.document.converter.pool.ConverterPoolException.

ConverterPoolException() - Constructor for class com.docmosis.document.converter.pool.ConverterPoolException

ConverterPoolException(String) - Constructor for class com.docmosis.document.converter.pool.ConverterPoolException

ConverterPoolException(String, Throwable) - Constructor for class com.docmosis.document.converter.pool.ConverterPoolException

ConverterPoolException(Throwable) - Constructor for class com.docmosis.document.converter.pool.ConverterPoolException

canRetry() - Method in class com.docmosis.document.ProcessingException

Determine if retrying the process might be viable.

cleanup() - Method in interface com.docmosis.template.Document

Release any resources held by this document (particularly closing any inputstream)

cleanup() - Method in interface com.docmosis.template.population.Cleanable

Perform any cleanup duties such as freeing resources.

cleanup() - Method in class com.docmosis.template.population.MemoryDataProvider

cleanup() - Method in class com.docmosis.template.population.NestingDataProvider

cleanupDataProvider() - Method in class com.docmosis.document.converter.ConversionInstruction

Determine if the DataProvider should be cleaned up at the end of the render process.

colour1 - Variable in class com.docmosis.template.population.render.AlternatingTableRowRenderer

colour2 - Variable in class com.docmosis.template.population.render.AlternatingTableRowRenderer

com.docmosis - package com.docmosis

com.docmosis.demo.web - package com.docmosis.demo.web

com.docmosis.document - package com.docmosis.document

com.docmosis.document.converter - package com.docmosis.document.converter

com.docmosis.document.converter.pool - package com.docmosis.document.converter.pool

com.docmosis.template - package com.docmosis.template

com.docmosis.template.analysis - package com.docmosis.template.analysis

com.docmosis.template.population - package com.docmosis.template.population

com.docmosis.template.population.format - package com.docmosis.template.population.format

com.docmosis.template.population.render - package com.docmosis.template.population.render

com.docmosis.template.store - package com.docmosis.template.store

compressSingleDocument() - Method in class com.docmosis.document.converter.ConversionInstruction

Determine whether to compress (zip) the resulting document if only a single format is being used.

create() - Method in class com.docmosis.template.population.MemoryDataProviderFactory

create() - Method in interface com.docmosis.template.population.MutableDataProviderFactory

create() - Method in class com.docmosis.template.population.SQLDataProviderFactory

createCompoundDataProvider(DataProvider[]) - Static method in class com.docmosis.template.population.DataProviderFactory

Create a CompoundDataProvider from the given array of DataProviders.

createCompoundDataProvider(List) - Static method in class com.docmosis.template.population.DataProviderFactory

Create a CompoundDataProvider from the given List of Objects.

createDataProvider(ResultSet, String) - Static method in class com.docmosis.template.population.DataProviderFactory

Create a simple data provider for a given SQL result set.

createDataProvider(ResultSet, DataProviderGrouping[]) - Static method in class com.docmosis.template.population.DataProviderFactory

Create a hierarchical data provider for a given SQL result set.

createDataProvider(Object) - Static method in class com.docmosis.template.population.DataProviderFactory

Create a Reflective data provider that extracts data from the given This data providers is forgiving (see ReflectiveDataProvider for more details).

createDataProvider(Object, boolean) - Static method in class com.docmosis.template.population.DataProviderFactory

Create a Reflective data provider that extracts data from the given Object and is optionally forgiving (see ReflectiveDataProvider for more details).

createDataProvider(String[][]) - Static method in class com.docmosis.template.population.DataProviderFactory

Create a hierarchical data provider for the given arrangement of key value pairs.

D

DataFormatter - interface com.docmosis.template.population.format.DataFormatter.

This interface specifies the required signature for a class that can provide format facilities for values produced by DataProviders.

DataProvider - interface com.docmosis.template.population.DataProvider.

The DataProvider interface marks classes that can provide data to the population phase of document production.

DataProviderBuilder - class com.docmosis.template.population.DataProviderBuilder.

This class helps to collect the data together for insertion into a document.

DataProviderBuilder() - Constructor for class com.docmosis.template.population.DataProviderBuilder

Construct a new DataProviderBuilder

DataProviderBuilder(MutableDataProvider) - Constructor for class com.docmosis.template.population.DataProviderBuilder

Construct a new DataProvider Builder using the given MutableDataProvider as the starting point.

DataProviderFactory - class com.docmosis.template.population.DataProviderFactory.

A convenience class for creating, building and extending DataProviders to feed templates.

DataProviderFactory() - Constructor for class com.docmosis.template.population.DataProviderFactory

DataProviderGrouping - interface com.docmosis.template.population.DataProviderGrouping.

An interface to act as a blueprint for what a data provider will look like.

DataProviderGroupingException - exception com.docmosis.template.population.DataProviderGroupingException.

A general exception for when data provider groupings are in an invalid state.

DataProviderGroupingException(String) - Constructor for class com.docmosis.template.population.DataProviderGroupingException

Create a new exception.

DataProviderKeyException - exception com.docmosis.template.population.DataProviderKeyException.

An exception used when attempting to use malformed data provider keys to represent a call to a hierarchical data provider structure.

DataProviderKeyException(String) - Constructor for class com.docmosis.template.population.DataProviderKeyException

Create a new exception.

DataProviderKeyParser - class com.docmosis.template.population.DataProviderKeyParser.

A utility class to parse keys for data provider elements.

DataProviderKeyParser() - Constructor for class com.docmosis.template.population.DataProviderKeyParser

DataProviderSQLGrouping - class com.docmosis.template.population.DataProviderSQLGrouping.

This class provides "grouping" information that is used to assist transforming a two-dimensional grid of data (eg a ResultSet) into a hierarchy of data.

DataProviderSQLGrouping(String, String[]) - Constructor for class com.docmosis.template.population.DataProviderSQLGrouping

Create a new grouping.

DataProviderSQLGrouping(String, Discriminator, String[]) - Constructor for class com.docmosis.template.population.DataProviderSQLGrouping

Create a new grouping.

DateDataFormatter - class com.docmosis.template.population.format.DateDataFormatter.

A formatter for formatting dates.

DateDataFormatter(String) - Constructor for class com.docmosis.template.population.format.DateDataFormatter

Construct a new DateDataFormatter using the given format string as the format for a SimpleDateFormat.

DateRenderer - class com.docmosis.template.population.render.DateRenderer.

A Date Renderer that supports a single parameter specifying the Date format to use.

DateRenderer() - Constructor for class com.docmosis.template.population.render.DateRenderer

DebugDataProvider - class com.docmosis.template.population.DebugDataProvider.

This DataProvider implementation has been added to help with debugging or analysing the process of template population.

DebugDataProvider() - Constructor for class com.docmosis.template.population.DebugDataProvider

Discriminator - class com.docmosis.template.population.Discriminator.

A class that looks for column (or multiple column) matches.

Discriminator(String) - Constructor for class com.docmosis.template.population.Discriminator

Create a single-columned discriminator.

Discriminator(String[]) - Constructor for class com.docmosis.template.population.Discriminator

Create a multi-columned discriminator.

Document - interface com.docmosis.template.Document.

DocumentProcessor - class com.docmosis.document.DocumentProcessor.

This class is the entry point for controlling the production of documents.

DocumentProcessor() - Constructor for class com.docmosis.document.DocumentProcessor

DropStoreHelper - class com.docmosis.template.store.DropStoreHelper.

This class makes it easier to pick up documents in a directory and register them into the (configured) store.

DropStoreHelper(TemplateStore) - Constructor for class com.docmosis.template.store.DropStoreHelper

Create a new DropStoreHelper object.

dataFormatManager - Variable in class com.docmosis.template.population.ReflectiveDataProvider

delegateCollection - Variable in class com.docmosis.template.population.ReflectiveCollectionDataProvider

deleteAll() - Method in interface com.docmosis.template.store.TemplateStore

Delete all templates in the store.

deleteTemplate(TemplateIdentifier) - Method in interface com.docmosis.template.store.TemplateStore

Delete the given template from the store.

deleteTemplates(TemplateContext, boolean) - Method in interface com.docmosis.template.store.TemplateStore

Delete all templates in the given context.

E

EMPTY_BOX_WINGDINGS - Static variable in class com.docmosis.document.CharacterConstants

equals(Object) - Method in class com.docmosis.document.converter.ConversionFormat

equals(Object) - Method in class com.docmosis.template.TemplateDetails

Test for equality.

equals(Object) - Method in class com.docmosis.template.population.Discriminator

Determine whether this object equals another.

equals(Object) - Method in class com.docmosis.template.store.TemplateContext

equals(Object) - Method in class com.docmosis.template.store.TemplateIdentifier

F

FORMAT_HTML - Static variable in class com.docmosis.document.converter.ConversionFormat

Specify HTML as the format

FORMAT_ODT - Static variable in class com.docmosis.document.converter.ConversionFormat

Specify ODT (Open Document Text) as the format

FORMAT_PDF - Static variable in class com.docmosis.document.converter.ConversionFormat

Specify PDF as the format

FORMAT_RTF - Static variable in class com.docmosis.document.converter.ConversionFormat

Specify RTF (Rich Text Format) as the format

FORMAT_TEXT - Static variable in class com.docmosis.document.converter.ConversionFormat

Specify TEXT as the format

FORMAT_WORD - Static variable in class com.docmosis.document.converter.ConversionFormat

Specify Word as the format

FORMAT_WORD_XML - Static variable in class com.docmosis.document.converter.ConversionFormat

Specify Word XML as the format

FieldAsciiRenderer - class com.docmosis.demo.web.FieldAsciiRenderer.

FieldAsciiRenderer() - Constructor for class com.docmosis.demo.web.FieldAsciiRenderer

FieldDetails - class com.docmosis.template.population.render.FieldDetails.

This object provides all the information about a field to be rendered.

FieldDetails(String, String, String, int, Class, Object, Class, Object, String, String[]) - Constructor for class com.docmosis.template.population.render.FieldDetails

FieldHtmlRenderer - class com.docmosis.demo.web.FieldHtmlRenderer.

A class for rendering fields into HTML format.

FieldHtmlRenderer() - Constructor for class com.docmosis.demo.web.FieldHtmlRenderer

FieldRenderer - interface com.docmosis.template.population.render.FieldRenderer.

This interface defines an object that can provide particular formatting features for a renderer.

finalize() - Method in class com.docmosis.template.population.MemoryDataProvider

findByContext(TemplateContext, boolean) - Method in interface com.docmosis.template.store.TemplateStore

Get the list of templates for the given context.

forgiving - Variable in class com.docmosis.template.population.ReflectiveDataProvider

format(Class, Object, String, Class) - Method in class com.docmosis.template.population.ReflectiveDataProvider.DataFormatManager

format(Class, Object, String, Class) - Method in class com.docmosis.template.population.format.BooleanDataFormatter

format(Class, Object, String, Class) - Method in interface com.docmosis.template.population.format.DataFormatter

Format the given value and return a String to display.

format(Class, Object, String, Class) - Method in class com.docmosis.template.population.format.DateDataFormatter

Format the given value and return a String to display.

G

GeneralHtmlRenderer - class com.docmosis.demo.web.GeneralHtmlRenderer.

A class for general rendering of non-data specific parts of a HTML document.

GeneralHtmlRenderer() - Constructor for class com.docmosis.demo.web.GeneralHtmlRenderer

GroupedSQLDataProviderPopulator - class com.docmosis.template.population.GroupedSQLDataProviderPopulator.

A class responsible for plugging data into a data provider given an SQL Result Set and a data provider grouping.

GroupedSQLDataProviderPopulatorTest4 - class com.docmosis.template.population.GroupedSQLDataProviderPopulatorTest4.

GroupedSQLDataProviderPopulatorTest4() - Constructor for class com.docmosis.template.population.GroupedSQLDataProviderPopulatorTest4

getAnalysis() - Method in interface com.docmosis.template.Template

getAnalysis() - Method in class com.docmosis.template.TemplateDetails

Get the analysis for this template.

getBold() - Method in class com.docmosis.template.population.render.RenderedField

Determine whether to add the bold font attribue.

getBoolean(String) - Method in class com.docmosis.template.population.CompoundDataProvider

Return the value from the first data provider that has a boolean for the given key.

getBoolean(String) - Method in interface com.docmosis.template.population.DataProvider

Determine if the given key hs been set to true.

getBoolean(String) - Method in class com.docmosis.template.population.DebugDataProvider

Log a call to this method and return true.

getBoolean(String) - Method in class com.docmosis.template.population.KeyedReflectiveDataProvider

getBoolean(String) - Method in class com.docmosis.template.population.MemoryDataProvider

getBoolean(String) - Method in class com.docmosis.template.population.NestingDataProvider

getBoolean(String) - Method in class com.docmosis.template.population.ReflectiveCollectionDataProvider

getBoolean(String) - Method in class com.docmosis.template.population.ReflectiveDataProvider

Get the boolean value from the reflected delegate.

getColumns() - Method in class com.docmosis.template.population.Discriminator

Return columns used for this discriminator.

getContainerClass() - Method in class com.docmosis.template.population.render.FieldDetails

Get the class of the container Java object providing the data (if from reflection).

getContainerObject() - Method in class com.docmosis.template.population.render.FieldDetails

Get the actual Java object that was queried to obtain the valueObject.

getContext() - Method in class com.docmosis.template.store.TemplateIdentifier

Get the context of this template.

getConversionFormats() - Method in class com.docmosis.document.converter.ConversionInstruction

Get the conversion formats specified by this instruction.

getConverterGroupName() - Method in class com.docmosis.document.converter.ConversionInstruction

Get the name of the Converter Group to use to render the document.

getDataItem(String) - Method in class com.docmosis.template.population.SQLDataProvider

getDataProvider(String, int) - Method in class com.docmosis.template.population.CompoundDataProvider

Return the value from the first data provider that has a DataProvider for the given key.

getDataProvider(String, int) - Method in interface com.docmosis.template.population.DataProvider

Get the data provider contained within this data provider with the given key as a name, and an index.

getDataProvider() - Method in class com.docmosis.template.population.DataProviderBuilder

Get the data provider that has been built so far.

getDataProvider(String, int) - Method in class com.docmosis.template.population.DebugDataProvider

Log a call to this method and return a new DebugDataProvider

getDataProvider(String, int) - Method in class com.docmosis.template.population.KeyedReflectiveDataProvider

getDataProvider(String, int) - Method in class com.docmosis.template.population.MemoryDataProvider

Get the data provider contained within this data provider with the given key as a name, and an index.

getDataProvider(String, int) - Method in class com.docmosis.template.population.NestingDataProvider

getDataProvider(String, int) - Method in class com.docmosis.template.population.ReflectiveCollectionDataProvider

getDataProvider(String, int) - Method in class com.docmosis.template.population.ReflectiveDataProvider

Get the data provider from the reflected delegate.

getDataProviderCount(String) - Method in class com.docmosis.template.population.CompoundDataProvider

Return the value from the first data provider that has a DataProvider for the given key.

getDataProviderCount(String) - Method in interface com.docmosis.template.population.DataProvider

Return the number of data providers contained within this data provider with the given key as a name.

getDataProviderCount(String) - Method in class com.docmosis.template.population.DebugDataProvider

Log a call to this method and return 1

getDataProviderCount(String) - Method in class com.docmosis.template.population.KeyedReflectiveDataProvider

getDataProviderCount(String) - Method in class com.docmosis.template.population.MemoryDataProvider

Return the number of data providers contained within this data provider with the given key as a name.

getDataProviderCount(String) - Method in class com.docmosis.template.population.NestingDataProvider

getDataProviderCount(String) - Method in class com.docmosis.template.population.ReflectiveCollectionDataProvider

getDataProviderCount(String) - Method in class com.docmosis.template.population.ReflectiveDataProvider

Get the data provider count from the reflected delegate.

getDelegate() - Method in class com.docmosis.template.population.ReflectiveDataProvider

Return the delegate inside this Reflective Data Provider.

getDetails() - Method in interface com.docmosis.template.Template

getDiscriminator() - Method in interface com.docmosis.template.population.DataProviderGrouping

Get the discriminator used to form data provider groups.

getDiscriminator() - Method in class com.docmosis.template.population.DataProviderSQLGrouping

Get the discriminator used to form data provider groups.

getExtension() - Method in class com.docmosis.document.converter.ConversionFormat

Get the typical file extension of this format.

getFieldName() - Method in class com.docmosis.template.population.render.FieldDetails

Get the name of the field.

getFieldValue() - Method in class com.docmosis.template.population.render.FieldDetails

Get the value to be displayed.

getFields() - Method in interface com.docmosis.template.analysis.TemplateAnalysis

Return only the fields in the template in the order they appear in the template.

getFields() - Method in interface com.docmosis.template.population.DataProviderGrouping

Get the names of all field that will be part of the data that the resulting data provider will provide.

getFields() - Method in class com.docmosis.template.population.DataProviderSQLGrouping

Get the names of all field that will be part of the data that the resulting data provider will provide.

getFormatForFileName(String) - Static method in class com.docmosis.document.converter.ConversionFormat

Get the format matching the given file name (by using the extension in a case-insensitive manner).

getFormatName() - Method in class com.docmosis.document.converter.ConversionFormat

Get the name of this format.

getId() - Method in interface com.docmosis.template.Template

getId() - Method in class com.docmosis.template.population.render.FieldDetails

Get the id for this field if one was specified in the template.

getImage(String) - Method in class com.docmosis.template.population.CompoundDataProvider

Return the value from the first data provider that has an image for the given key.

getImage(String) - Method in interface com.docmosis.template.population.DataProvider

Get an InputStream over the image with the given key.

getImage(String) - Method in class com.docmosis.template.population.DebugDataProvider

Log a call to this method and return null.

getImage(String) - Method in class com.docmosis.template.population.KeyedReflectiveDataProvider

getImage(String) - Method in class com.docmosis.template.population.MemoryDataProvider

Get the input stream over the image with the given key.

getImage(String) - Method in class com.docmosis.template.population.NestingDataProvider

getImage(String) - Method in class com.docmosis.template.population.ReflectiveCollectionDataProvider

getImage(String) - Method in class com.docmosis.template.population.ReflectiveDataProvider

Get the image from the reflected delegate.

getInputStream() - Method in interface com.docmosis.template.Document

getInstance(Object) - Static method in class com.docmosis.template.population.ReflectiveDataProvider

Obtain a new Reflective Data Provider that will pull data out of the given delegate.

getInstance(Object, boolean) - Static method in class com.docmosis.template.population.ReflectiveDataProvider

obtain a new Reflective Data Provider that will pull data out of the given delegate.

getItalic() - Method in class com.docmosis.template.population.render.RenderedField

Determine whether to add the italic font attribue.

getLastDataProvider() - Method in class com.docmosis.template.population.CompoundDataProvider

Get the last DataProvider in the compounded set of data providers

getLastModified() - Method in class com.docmosis.template.TemplateDetails

Get the time (in milliseconds since the epoch) since this template was last updated.

getLength() - Method in interface com.docmosis.template.Document

getLength() - Method in interface com.docmosis.template.analysis.TemplateAnalysis

Obtain the total size of the template.

getName() - Method in interface com.docmosis.template.population.DataProviderGrouping

Get the name for the grouping.

getName() - Method in class com.docmosis.template.population.DataProviderSQLGrouping

Get the name for the grouping.

getName() - Method in class com.docmosis.template.store.TemplateIdentifier

Get the name for this template id.

getOriginalLastModified() - Method in class com.docmosis.template.TemplateDetails

Get the time (in milliseconds since the epoch) since the original template was last updated.

getOriginalMD5() - Method in interface com.docmosis.template.analysis.TemplateAnalysis

The the MD5 hash string that the template had at the time of storing.

getOriginalSize() - Method in class com.docmosis.template.TemplateDetails

Get the size of original of this template.

getOriginalTemplate(TemplateIdentifier) - Method in interface com.docmosis.template.store.TemplateStore

Get the original template provided in storeTemplate().

getOutputFileName() - Method in class com.docmosis.document.converter.ConversionInstruction

getPath() - Method in class com.docmosis.template.store.TemplateContext

Return this context as a path that may be used to store or retrieve the template.

getRealKey(String) - Static method in class com.docmosis.template.population.MemoryDataProvider

Depending on whether we are in case-sensitive mode, return a case-edited version of the key.

getRendererName() - Method in class com.docmosis.template.population.render.FieldDetails

Get the name of the renderer.

getRendererParams() - Method in class com.docmosis.template.population.render.FieldDetails

Get any parameters specified for a renderer.

getRendererRegistry() - Method in class com.docmosis.document.converter.ConversionInstruction

Get the collection of renderers registry that have been set into this instruction.

getRowNum() - Method in class com.docmosis.template.population.render.FieldDetails

Get the row number if in a repeating table.

getSections() - Method in interface com.docmosis.template.analysis.TemplateAnalysis

Get the breakdown of a template as a set of sections.

getSize() - Method in class com.docmosis.template.TemplateDetails

Get the size of this template.

getStaticNewStyles() - Method in interface com.docmosis.template.analysis.TemplateAnalysis

Get any new styles derived during analysis

getStore() - Static method in class com.docmosis.template.store.TemplateStoreFactory

Get the current Template Store.

getStore(String) - Static method in class com.docmosis.template.store.TemplateStoreFactory

Get (and initialise if necessary) the template store to use based on current configuration.

getString(String) - Method in class com.docmosis.template.population.CompoundDataProvider

Return the value from the first data provider that has a String for the given key.

getString(String) - Method in interface com.docmosis.template.population.DataProvider

Get the value for the given key

getString(String) - Method in class com.docmosis.template.population.DebugDataProvider

Log a call to this method and return the given key.

getString(String) - Method in class com.docmosis.template.population.KeyedReflectiveDataProvider

getString(String) - Method in class com.docmosis.template.population.MemoryDataProvider

Gets the string set to the given value.

getString(String) - Method in class com.docmosis.template.population.NestingDataProvider

getString(String) - Method in class com.docmosis.template.population.ReflectiveCollectionDataProvider

getString(String) - Method in class com.docmosis.template.population.ReflectiveDataProvider

Get the String from the reflected delegate.

getString(String) - Method in class com.docmosis.template.population.SQLDataProvider

Get the value for the given string key.

getTableCellBackgroundColour() - Method in class com.docmosis.template.population.render.RenderedField

Specify the background cell colour.

getTemplate(TemplateIdentifier) - Method in interface com.docmosis.template.store.TemplateStore

Get the (working) template identified by the given templateId.

getTemplateAnalysis(TemplateIdentifier) - Method in interface com.docmosis.template.store.TemplateStore

Get the template analysis for the template identified by the given template info.

getTemplateStoredTime(TemplateIdentifier) - Method in interface com.docmosis.template.store.TemplateStore

Return the time that the template was stored in this template store.

getThumbnail() - Method in class com.docmosis.template.TemplateDetails

Get an File handle over the thumbnail for image for this template.

getUnderline() - Method in class com.docmosis.template.population.render.RenderedField

Determine whether to add the underline font attribue.

getValue() - Method in class com.docmosis.template.population.render.RenderedField

Get the text to display for the field.

getValueClass() - Method in class com.docmosis.template.population.render.FieldDetails

Get the class of the value (if the value was obtained from reflection).

getValueObject() - Method in class com.docmosis.template.population.render.FieldDetails

Get the value in its original form (if the value was obtained from reflection).

H

hasBooleanKey(String) - Method in class com.docmosis.template.population.CompoundDataProvider

Return true if any data provider has a boolean for the given key

hasBooleanKey(String) - Method in interface com.docmosis.template.population.DataProvider

Determine if a value for the boolean key has been specified

hasBooleanKey(String) - Method in class com.docmosis.template.population.DebugDataProvider

Log a call to this method and return true.

hasBooleanKey(String) - Method in class com.docmosis.template.population.KeyedReflectiveDataProvider

hasBooleanKey(String) - Method in class com.docmosis.template.population.MemoryDataProvider

hasBooleanKey(String) - Method in class com.docmosis.template.population.NestingDataProvider

hasBooleanKey(String) - Method in class com.docmosis.template.population.ReflectiveCollectionDataProvider

hasBooleanKey(String) - Method in class com.docmosis.template.population.ReflectiveDataProvider

Determine if the boolean key has been set.

hasDataItem(String) - Method in class com.docmosis.template.population.SQLDataProvider

hasDataProviderKey(String) - Method in class com.docmosis.template.population.CompoundDataProvider

Return true if any data provider has a DataProvider for the given key

hasDataProviderKey(String) - Method in interface com.docmosis.template.population.DataProvider

Determine if a data provider for the key has been specified (even if null)

hasDataProviderKey(String) - Method in class com.docmosis.template.population.DebugDataProvider

Log a call to this method and return true

hasDataProviderKey(String) - Method in class com.docmosis.template.population.KeyedReflectiveDataProvider

hasDataProviderKey(String) - Method in class com.docmosis.template.population.MemoryDataProvider

NOTE: This method does not support nesting of the key value.

hasDataProviderKey(String) - Method in class com.docmosis.template.population.NestingDataProvider

hasDataProviderKey(String) - Method in class com.docmosis.template.population.ReflectiveCollectionDataProvider

hasDataProviderKey(String) - Method in class com.docmosis.template.population.ReflectiveDataProvider

Determine if the data provider key has been set.

hasDynamicTableStyling() - Method in interface com.docmosis.template.analysis.TemplateAnalysis

Determine if this template has tables with dynamic styling.

hasImageKey(String) - Method in class com.docmosis.template.population.CompoundDataProvider

Return true if any data provider has an image for the given key

hasImageKey(String) - Method in interface com.docmosis.template.population.DataProvider

Determine if the given image has been set (even if to null)

hasImageKey(String) - Method in class com.docmosis.template.population.DebugDataProvider

Log a call to this method and return false.

hasImageKey(String) - Method in class com.docmosis.template.population.KeyedReflectiveDataProvider

hasImageKey(String) - Method in class com.docmosis.template.population.MemoryDataProvider

hasImageKey(String) - Method in class com.docmosis.template.population.NestingDataProvider

hasImageKey(String) - Method in class com.docmosis.template.population.ReflectiveCollectionDataProvider

hasImageKey(String) - Method in class com.docmosis.template.population.ReflectiveDataProvider

Determine if the image key has been set.

hasOnlineConverters() - Static method in class com.docmosis.document.DocumentProcessor

Determine if there are any online converters in the default Converter Pool Group.

hasOnlineConverters(String) - Static method in class com.docmosis.document.DocumentProcessor

Determine if there are any online converters in the given Converter Pool Group.

hasStringKey(String) - Method in class com.docmosis.template.population.CompoundDataProvider

Return true if any data provider has a String for the given key

hasStringKey(String) - Method in interface com.docmosis.template.population.DataProvider

Determine if the given string has been set (even if to null)

hasStringKey(String) - Method in class com.docmosis.template.population.DebugDataProvider

Log a call to this method and return true.

hasStringKey(String) - Method in class com.docmosis.template.population.KeyedReflectiveDataProvider

hasStringKey(String) - Method in class com.docmosis.template.population.MemoryDataProvider

hasStringKey(String) - Method in class com.docmosis.template.population.NestingDataProvider

hasStringKey(String) - Method in class com.docmosis.template.population.ReflectiveCollectionDataProvider

hasStringKey(String) - Method in class com.docmosis.template.population.ReflectiveDataProvider

Determine if the String key has been set.

hasStringKey(String) - Method in class com.docmosis.template.population.SQLDataProvider

Determine if this dataprovider has a value for the key.

hasTemplateErrors() - Method in interface com.docmosis.template.analysis.TemplateAnalysis

Determine if the template has errors in it.

hashCode() - Method in class com.docmosis.document.converter.ConversionFormat

hashCode() - Method in class com.docmosis.template.TemplateDetails

hashCode() - Method in class com.docmosis.template.population.Discriminator

hashCode() - Method in class com.docmosis.template.store.TemplateContext

hashCode() - Method in class com.docmosis.template.store.TemplateIdentifier

I

initialise() - Static method in class com.docmosis.SystemManager

Initialise the system from the configuration.

initialise() - Static method in class com.docmosis.template.store.TemplateStoreFactory

Initialise the Template Store factory.

isCompressingSingleDocument() - Method in class com.docmosis.document.converter.ConversionInstruction

Determine if a single resulting document should be automatically zipped to create a smaller file.

isDueToServiceFailure - Variable in class com.docmosis.document.converter.ConversionException

isDueToServiceFailure() - Method in class com.docmosis.document.converter.ConversionException

isForgiving() - Method in class com.docmosis.template.population.ReflectiveDataProvider

Determine if this instance is forgiving or not.

isInitialized() - Static method in class com.docmosis.SystemManager

Determine if the system has been initialized.

isPrimitive(Object) - Static method in class com.docmosis.template.population.ReflectiveDataProvider

Determine if the given object is one of the "primitive" java types.

isPrimitiveArray(Object) - Static method in class com.docmosis.template.population.ReflectiveDataProvider

Determine if the given object is one of the "primitive" java array types.

K

KeyedReflectiveDataProvider - class com.docmosis.template.population.KeyedReflectiveDataProvider.

KeyedReflectiveDataProvider(String, Object, boolean) - Constructor for class com.docmosis.template.population.KeyedReflectiveDataProvider

L

logCall(Logger, String, String) - Method in class com.docmosis.template.population.ReflectiveDataProvider

Log a call to any of the retrieval methods.

logCall(Logger, String, String, int) - Method in class com.docmosis.template.population.ReflectiveDataProvider

Log a call to any of the retrieval methods.

M

METHOD_REFLECTION_HELPER - Static variable in class com.docmosis.template.population.ReflectiveDataProvider

MemoryDataProvider - class com.docmosis.template.population.MemoryDataProvider.

An efficient memory based DataProvider.

MemoryDataProvider() - Constructor for class com.docmosis.template.population.MemoryDataProvider

MemoryDataProviderFactory - class com.docmosis.template.population.MemoryDataProviderFactory.

MemoryDataProviderFactory() - Constructor for class com.docmosis.template.population.MemoryDataProviderFactory

MutableDataProvider - interface com.docmosis.template.population.MutableDataProvider.

An interface for a data provider that is editable.

MutableDataProviderFactory - interface com.docmosis.template.population.MutableDataProviderFactory.

N

NestedSectionRenderer - interface com.docmosis.demo.web.NestedSectionRenderer.

An interface for rendering sections of a template analysis in some sort of nested viewable format.

NestingDataProvider - class com.docmosis.template.population.NestingDataProvider.

NestingDataProvider(DataProvider) - Constructor for class com.docmosis.template.population.NestingDataProvider

NestingDataProvider(DataProvider, MutableDataProviderFactory) - Constructor for class com.docmosis.template.population.NestingDataProvider

NoSuchColumnNameException - exception com.docmosis.template.population.NoSuchColumnNameException.

This exception should be used when the data provider population process finds a column in the groupings that does not exist in the result set.

NoSuchColumnNameException(String) - Constructor for class com.docmosis.template.population.NoSuchColumnNameException

Create a new exception with a message.

P

PopulationException - exception com.docmosis.template.population.PopulationException.

PopulationException() - Constructor for class com.docmosis.template.population.PopulationException

PopulationException(String) - Constructor for class com.docmosis.template.population.PopulationException

PopulationException(Throwable) - Constructor for class com.docmosis.template.population.PopulationException

PopulationException(String, Throwable) - Constructor for class com.docmosis.template.population.PopulationException

ProcessingException - exception com.docmosis.document.ProcessingException.

This general exception indicates something went wrong with the procesing of the documents or templates.

ProcessingException() - Constructor for class com.docmosis.document.ProcessingException

ProcessingException(String) - Constructor for class com.docmosis.document.ProcessingException

ProcessingException(Throwable) - Constructor for class com.docmosis.document.ProcessingException

ProcessingException(String, Throwable) - Constructor for class com.docmosis.document.ProcessingException

parse(String) - Static method in class com.docmosis.template.population.DataProviderKeyParser

Parse a key to fit into a hierarchical structure of a memory data provider.

populateDataProvider(MutableDataProvider, ResultSet, DataProviderGrouping[]) - Static method in class com.docmosis.template.population.GroupedSQLDataProviderPopulator

Populate a data provider.

populateDataProvider(MutableDataProvider, ResultSet, String) - Static method in class com.docmosis.template.population.SimpleSQLDataProviderPopulator

Get the grid-like data provider populated by this class.

process(File) - Method in class com.docmosis.template.store.DropStoreHelper

Drop a whole directory of templates into the store optionally processing sub-directories.

process(File, TemplateContext) - Method in class com.docmosis.template.store.DropStoreHelper

Drop a whole directory of templates into the store optionally processing sub-directories.

process(File, TemplateContext, boolean) - Method in class com.docmosis.template.store.DropStoreHelper

Drop a whole directory of templates into the store optionally processing sub-directories.

process(File, boolean) - Method in class com.docmosis.template.store.DropStoreHelper

Drop a whole directory of templates into the store optionally processing sub-directories.

process(File, boolean, boolean) - Method in class com.docmosis.template.store.DropStoreHelper

Deprecated. Deletion of unknown templates is no longer supported. The deletion flag is ignored.

process(File, TemplateContext, boolean, boolean) - Method in class com.docmosis.template.store.DropStoreHelper

Deprecated. Deletion of unknown templates is no longer supported. The deletion flag is ignored.

processJarOrZipFile(File, TemplateContext, boolean) - Method in class com.docmosis.template.store.DropStoreHelper

Process the contents of a Jar or Zip file as it if was a directory.

processResource(URL, TemplateContext, boolean) - Method in class com.docmosis.template.store.DropStoreHelper

Process templates from the specified URL.

R

ReflectiveCollectionDataProvider - class com.docmosis.template.population.ReflectiveCollectionDataProvider.

ReflectiveCollectionDataProvider(Object, boolean, ReflectiveDataProvider.DataFormatManager) - Constructor for class com.docmosis.template.population.ReflectiveCollectionDataProvider

ReflectiveDataProvider - class com.docmosis.template.population.ReflectiveDataProvider.

This data provider uses reflection to try to obtain data from within an arbitrary given object.

ReflectiveDataProvider(Object, boolean, ReflectiveDataProvider.DataFormatManager) - Constructor for class com.docmosis.template.population.ReflectiveDataProvider

Construct a new Reflective Data Provider that will pull data out of the given delegate.

ReflectiveDataProvider.DataFormatManager - class com.docmosis.template.population.ReflectiveDataProvider.DataFormatManager.

A Manager of data formats that are applied to the results of reflective calls to format the data before it is passed into the render process.

ReflectiveDataProvider.DataFormatManager() - Constructor for class com.docmosis.template.population.ReflectiveDataProvider.DataFormatManager

RenderedField - class com.docmosis.template.population.render.RenderedField.

A "logical" rendered field providing the actual rendering classes with information that can change presentation of the field.

RenderedField() - Constructor for class com.docmosis.template.population.render.RenderedField

RepeatableSectionHtmlRenderer - class com.docmosis.demo.web.RepeatableSectionHtmlRenderer.

RepeatableSectionHtmlRenderer() - Constructor for class com.docmosis.demo.web.RepeatableSectionHtmlRenderer

reflectedDelegate - Variable in class com.docmosis.template.population.ReflectiveDataProvider

reflectedDelegateClass - Variable in class com.docmosis.template.population.ReflectiveDataProvider

release() - Static method in class com.docmosis.SystemManager

Shuts down everything in the system, so that it can be re-initialised from scratch.

release() - Static method in class com.docmosis.template.store.TemplateStoreFactory

Release the template store from memory.

removeFormatter(Class) - Method in class com.docmosis.template.population.ReflectiveDataProvider.DataFormatManager

render(TemplateSection[], PrintWriter) - Method in class com.docmosis.demo.web.AnalysisFormRenderer

Render all sections (recursively).

render(TemplateSection, String, PrintWriter) - Method in class com.docmosis.demo.web.AnalysisFormRenderer

Render the single section.

render(TemplateSection, PrintWriter) - Method in class com.docmosis.demo.web.FieldAsciiRenderer

Render a section to the given print writer.

render(TemplateSection, PrintWriter, int) - Method in class com.docmosis.demo.web.FieldAsciiRenderer

Render a section to the given print writer at a particular indenting level.

render(TemplateSection, PrintWriter) - Method in interface com.docmosis.demo.web.SectionRenderer

Render a section to the given print writer.

render(TemplateSection, PrintWriter, int) - Method in interface com.docmosis.demo.web.SectionRenderer

Render a section to the given print writer at a particular indenting level.

render(FieldDetails, RenderedField) - Method in class com.docmosis.template.population.render.AlternatingTableRowRenderer

render(FieldDetails, RenderedField) - Method in class com.docmosis.template.population.render.BooleanRenderer

render(FieldDetails, RenderedField) - Method in class com.docmosis.template.population.render.DateRenderer

render(FieldDetails, RenderedField) - Method in interface com.docmosis.template.population.render.FieldRenderer

Make rendering adjustments for a field.

renderClose(TemplateSection, boolean, boolean, PrintWriter) - Method in class com.docmosis.demo.web.FieldHtmlRenderer

Render the closing portion of a section to the given print writer at a particular indenting level.

renderClose(TemplateSection, boolean, boolean, PrintWriter) - Method in interface com.docmosis.demo.web.NestedSectionRenderer

Render the closing portion of a section to the given print writer.

renderClose(TemplateSection, boolean, boolean, PrintWriter) - Method in class com.docmosis.demo.web.RepeatableSectionHtmlRenderer

Render the closing portion of a section to the given print writer at a particular indenting level.

renderDoc(TemplateIdentifier, DataProvider, ConversionInstruction, OutputStream) - Static method in class com.docmosis.document.DocumentProcessor

Render the template specified by the given templateId with the given data according to the given instruction.

renderDoc(File, File, DataProvider) - Static method in class com.docmosis.document.DocumentProcessor

Render the given template to the given output file with the given data.

renderDoc(File, OutputStream, ConversionFormat, DataProvider) - Static method in class com.docmosis.document.DocumentProcessor

Render the given template to the given output stream with the given data.

renderDocumentEnd(PrintWriter) - Method in class com.docmosis.demo.web.GeneralHtmlRenderer

Render the end of the HTML document.

renderDocumentStart(String, PrintWriter) - Method in class com.docmosis.demo.web.GeneralHtmlRenderer

Render the start of the HTML document.

renderOpen(TemplateSection, String, boolean, boolean, PrintWriter) - Method in class com.docmosis.demo.web.FieldHtmlRenderer

Render the opening portion of a section to the given print writer.

renderOpen(TemplateSection, String, boolean, boolean, PrintWriter) - Method in interface com.docmosis.demo.web.NestedSectionRenderer

Render the opening portion of a section to the given print writer.

renderOpen(TemplateSection, String, boolean, boolean, PrintWriter) - Method in class com.docmosis.demo.web.RepeatableSectionHtmlRenderer

Render the opening portion of a section to the given print writer.

S

SQLDataProvider - class com.docmosis.template.population.SQLDataProvider.

Currently the SQL Data Provider doesn't support Image Data being provided by the database.

SQLDataProvider() - Constructor for class com.docmosis.template.population.SQLDataProvider

SQLDataProviderFactory - class com.docmosis.template.population.SQLDataProviderFactory.

SQLDataProviderFactory() - Constructor for class com.docmosis.template.population.SQLDataProviderFactory

SectionRenderer - interface com.docmosis.demo.web.SectionRenderer.

An interface for rendering sections of a template analysis in some sort of viewable format.

SimpleSQLDataProviderPopulator - class com.docmosis.template.population.SimpleSQLDataProviderPopulator.

A class responsible for populating a data provider given an SQL Result Set.

StoreHelper - class com.docmosis.template.store.StoreHelper.

This class provides methods to register templates into the template store.

StoreHelper() - Constructor for class com.docmosis.template.store.StoreHelper

SystemManager - class com.docmosis.SystemManager.

Initialise the document processing system.

SystemManager() - Constructor for class com.docmosis.SystemManager

setBold(boolean) - Method in class com.docmosis.template.population.render.RenderedField

setBoolean(String, boolean) - Method in class com.docmosis.template.population.MemoryDataProvider

Puts the given value for the given key.

setBoolean(String, boolean) - Method in interface com.docmosis.template.population.MutableDataProvider

setBoolean(String, boolean) - Method in class com.docmosis.template.population.NestingDataProvider

setCanRetry(boolean) - Method in class com.docmosis.document.ProcessingException

Set the retry flag.

setCellBackgroundColour(String) - Method in class com.docmosis.template.population.render.RenderedField

setCleanupDataProvider(boolean) - Method in class com.docmosis.document.converter.ConversionInstruction

Specify whether the data provider should be cleaned up at the end of the render process.

setCompressingSingleDocument(boolean) - Method in class com.docmosis.document.converter.ConversionInstruction

Specify whether a single resulting document should be automatically zipped to create a smaller file.

setConversionFormats(ConversionFormat[]) - Method in class com.docmosis.document.converter.ConversionInstruction

Specify the conversion formats for the returned result.

setConverterGroupName(String) - Method in class com.docmosis.document.converter.ConversionInstruction

Specify the name of the converter pool group to which this task is to be assigned.

setDataFormatter(Class, DataFormatter) - Method in class com.docmosis.template.population.NestingDataProvider

setDataFormatter(Class, DataFormatter) - Method in class com.docmosis.template.population.ReflectiveDataProvider

Set the formatter for the given class type.

setDataItem(String, SQLDataItem) - Method in class com.docmosis.template.population.SQLDataProvider

Sets the given value for the given key.

setDateFormat(String) - Method in class com.docmosis.template.population.NestingDataProvider

setDateFormat(SimpleDateFormat) - Method in class com.docmosis.template.population.NestingDataProvider

setDateFormat(SimpleDateFormat) - Method in class com.docmosis.template.population.ReflectiveDataProvider

Set the Date Format to use when rendering dates as Strings.

setDateFormat(String) - Method in class com.docmosis.template.population.ReflectiveDataProvider

Set the Date Format to use a SimpleDateFormat using the given format string as the format.

setDefaultRenderer(String, FieldRenderer) - Static method in class com.docmosis.document.DocumentProcessor

Set a "default" renderer against the given name for system wide use.

setDefaultRenderer(Class, FieldRenderer) - Static method in class com.docmosis.document.DocumentProcessor

Set a "default" renderer against the given Class for system wide use.

setFalse(String) - Method in class com.docmosis.template.population.MemoryDataProvider

Add a false value at the given key.

setFalse(String) - Method in interface com.docmosis.template.population.MutableDataProvider

setFalse(String) - Method in class com.docmosis.template.population.NestingDataProvider

setFormatter(Class, DataFormatter) - Method in class com.docmosis.template.population.ReflectiveDataProvider.DataFormatManager

Set a formatter for the given type.

setImage(String, File) - Method in class com.docmosis.template.population.MemoryDataProvider

Puts the given image for the given key.

setImage(String, InputStream) - Method in class com.docmosis.template.population.MemoryDataProvider

Put the given inputstream for an image against the given key.

setImage(String, File) - Method in interface com.docmosis.template.population.MutableDataProvider

setImage(String, InputStream) - Method in interface com.docmosis.template.population.MutableDataProvider

setImage(String, File) - Method in class com.docmosis.template.population.NestingDataProvider

setImage(String, File, MutableDataProvider, MutableDataProviderFactory) - Static method in class com.docmosis.template.population.NestingDataProvider

setImage(String, InputStream) - Method in class com.docmosis.template.population.NestingDataProvider

setImage(String, InputStream, MutableDataProvider, MutableDataProviderFactory) - Static method in class com.docmosis.template.population.NestingDataProvider

setItalic(boolean) - Method in class com.docmosis.template.population.render.RenderedField

setOutputFileName(String) - Method in class com.docmosis.document.converter.ConversionInstruction

Specify the filename for output.

setRenderer(String, FieldRenderer) - Method in class com.docmosis.document.converter.ConversionInstruction

Set a renderer with the given name for use with this instruction.

setRenderer(Class, FieldRenderer) - Method in class com.docmosis.document.converter.ConversionInstruction

Set a renderer against the given Class for use with this instruction.

setString(String, String) - Method in class com.docmosis.template.population.MemoryDataProvider

Sets the given value for the given key.

setString(String, String) - Method in interface com.docmosis.template.population.MutableDataProvider

setString(String, String) - Method in class com.docmosis.template.population.NestingDataProvider

setString(String, String, MutableDataProvider, MutableDataProviderFactory) - Static method in class com.docmosis.template.population.NestingDataProvider

setTrue(String) - Method in class com.docmosis.template.population.MemoryDataProvider

Add a true value at the given key.

setTrue(String) - Method in interface com.docmosis.template.population.MutableDataProvider

setTrue(String) - Method in class com.docmosis.template.population.NestingDataProvider

setUnderline(boolean) - Method in class com.docmosis.template.population.render.RenderedField

setUp() - Method in class com.docmosis.template.population.GroupedSQLDataProviderPopulatorTest4

setValue(String) - Method in class com.docmosis.template.population.render.RenderedField

storeTemplate(String, File, TemplateStore) - Static method in class com.docmosis.template.store.StoreHelper

Store a template in the given template store.

storeTemplate(String, File, boolean, TemplateStore) - Static method in class com.docmosis.template.store.StoreHelper

Store a template in the given template store (this process is known as template registration) specifying whether to overwrite any existing registrations or not.

storeTemplate(TemplateIdentifier, File, TemplateStore) - Static method in class com.docmosis.template.store.StoreHelper

Store a template in the given template store (this process is known as template registration).

storeTemplate(TemplateIdentifier, InputStream, boolean, boolean, TemplateStore) - Static method in class com.docmosis.template.store.StoreHelper

Store the given template stream against the given templateId in the given store.

storeTemplate(TemplateIdentifier, File, boolean, boolean, TemplateStore) - Static method in class com.docmosis.template.store.StoreHelper

Store a template in the given template store (this process is known as template registration).

storeTemplate(TemplateIdentifier, InputStream, InputStream, TemplateAnalysis, InputStream, boolean) - Method in interface com.docmosis.template.store.TemplateStore

Store the given InputStream as a template using the given templateId.

T

TICK2_DINGBATS - Static variable in class com.docmosis.document.CharacterConstants

TICK_BOXED_WINGDINGS - Static variable in class com.docmosis.document.CharacterConstants

TICK_DINGBATS - Static variable in class com.docmosis.document.CharacterConstants

TICK_WINGDINGS - Static variable in class com.docmosis.document.CharacterConstants

Template - interface com.docmosis.template.Template.

This interface defines the minimal facilities a template must provide.

TemplateAlreadyExistsException - exception com.docmosis.template.TemplateAlreadyExistsException.

This exception is used to identify a problem parsing a template.

TemplateAlreadyExistsException() - Constructor for class com.docmosis.template.TemplateAlreadyExistsException

TemplateAlreadyExistsException(String, Throwable) - Constructor for class com.docmosis.template.TemplateAlreadyExistsException

TemplateAlreadyExistsException(String) - Constructor for class com.docmosis.template.TemplateAlreadyExistsException

TemplateAlreadyExistsException(Throwable) - Constructor for class com.docmosis.template.TemplateAlreadyExistsException

TemplateAnalysis - interface com.docmosis.template.analysis.TemplateAnalysis.

A template anaylsis provides details about a (populatable) template that may help in processing the template (performance hints).

TemplateContext - class com.docmosis.template.store.TemplateContext.

The context of a template.

TemplateContext(String) - Constructor for class com.docmosis.template.store.TemplateContext

Construct a new context with the given string as the path.

TemplateDetails - class com.docmosis.template.TemplateDetails.

A simple holder of details for a template.

TemplateDetails(TemplateIdentifier, long, long, long, long, TemplateAnalysis, File) - Constructor for class com.docmosis.template.TemplateDetails

Construct a new template details object with the given information

TemplateIdentifier - class com.docmosis.template.store.TemplateIdentifier.

A Template can be uniquely identified by a name and a context.

TemplateIdentifier(String) - Constructor for class com.docmosis.template.store.TemplateIdentifier

Construct a new template identifier with the given name and a template context matching the root (or top-level) of the store.

TemplateIdentifier(String, TemplateContext) - Constructor for class com.docmosis.template.store.TemplateIdentifier

Construct a new identifer with the given name and context.

TemplateNotFoundException - exception com.docmosis.template.TemplateNotFoundException.

TemplateNotFoundException() - Constructor for class com.docmosis.template.TemplateNotFoundException

TemplateNotFoundException(String) - Constructor for class com.docmosis.template.TemplateNotFoundException

TemplateNotFoundException(Throwable) - Constructor for class com.docmosis.template.TemplateNotFoundException

TemplateNotFoundException(String, Throwable) - Constructor for class com.docmosis.template.TemplateNotFoundException

TemplateStore - interface com.docmosis.template.store.TemplateStore.

This interface provides access to systems for storage and retrieval of templates.

TemplateStoreException - exception com.docmosis.template.TemplateStoreException.

TemplateStoreException() - Constructor for class com.docmosis.template.TemplateStoreException

TemplateStoreException(String) - Constructor for class com.docmosis.template.TemplateStoreException

TemplateStoreException(Throwable) - Constructor for class com.docmosis.template.TemplateStoreException

TemplateStoreException(String, Throwable) - Constructor for class com.docmosis.template.TemplateStoreException

TemplateStoreFactory - class com.docmosis.template.store.TemplateStoreFactory.

This factory provides TemplateStore instances.

TemplateStoreFactory() - Constructor for class com.docmosis.template.store.TemplateStoreFactory

tearDown() - Method in class com.docmosis.template.population.GroupedSQLDataProviderPopulatorTest4

templateExists(TemplateIdentifier, TemplateStore) - Static method in class com.docmosis.template.store.StoreHelper

Determines whether the given template exists in the store.

testHotelExplicitDiscriminator() - Method in class com.docmosis.template.population.GroupedSQLDataProviderPopulatorTest4

testHotelImplicitDiscriminator() - Method in class com.docmosis.template.population.GroupedSQLDataProviderPopulatorTest4

toDebugString() - Method in class com.docmosis.template.population.MemoryDataProvider

Return the contents represented by a single string, for debug purposes.

toDebugString(int) - Method in class com.docmosis.template.population.MemoryDataProvider

toDebugString(int) - Method in class com.docmosis.template.population.NestingDataProvider

toDebugString(int) - Method in class com.docmosis.template.population.SQLDataProvider

toString() - Method in class com.docmosis.template.TemplateDetails

toString() - Method in class com.docmosis.template.population.CompoundDataProvider

toString() - Method in class com.docmosis.template.population.DataProviderBuilder

toString() - Method in class com.docmosis.template.population.Discriminator

toString() - Method in class com.docmosis.template.population.KeyedReflectiveDataProvider

toString() - Method in class com.docmosis.template.population.MemoryDataProvider

toString() - Method in class com.docmosis.template.population.NestingDataProvider

toString() - Method in class com.docmosis.template.population.ReflectiveDataProvider

toString() - Method in class com.docmosis.template.population.SQLDataProvider

toString() - Method in class com.docmosis.template.store.TemplateContext

toString() - Method in class com.docmosis.template.store.TemplateIdentifier

A B C D E F G H I K L M N P R S T