Index (Docmosis API 4.9.0)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Docmosis API 4.9.0

PREV NEXT

FRAMES NO FRAMES

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

A

accept(Node) - Method in interface com.docmosis.template.population.XMLNodeFilter: Determine whether a node should be accepted through this filter.
add(String, String, String) - Method in class com.docmosis.template.analysis.list.ListStyles
add(long, long, boolean, boolean, boolean, boolean) - Method in class com.docmosis.template.analysis.TextWritableSafeAreas: Start recording a writable area immediately after the given end index.
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(DataProviderBuilder, String) - Method in class com.docmosis.template.population.DataProviderBuilder: Add the given data provider builder's contents 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(Map[], String) - Method in class com.docmosis.template.population.DataProviderBuilder: Add all key value pairs from each map in the given array to this builder.
addAll(String[][][], String) - Method in class com.docmosis.template.population.DataProviderBuilder: Add all key value pairs from each String[][] in the given array to this builder.
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.
addBlank(String) - Method in class com.docmosis.template.analysis.list.ListStyles
addChild(String, String) - Method in class com.docmosis.template.analysis.list.ListTree
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.
addDerivedStyle(ListStyle) - Method in class com.docmosis.template.analysis.list.ListStyles
addElementsToDocument(MemoryDataProvider, Node, Document) - Static method in class com.docmosis.template.population.XMLDataProvider: Adds all immediate fields to the given XML node.
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 (see Warnings).
addJavaObject(Object, boolean) - Method in class com.docmosis.template.population.DataProviderBuilder: Add a Java object to the "top level" of our data (see Warnings).
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.
addJavaObject(Object, String, boolean) - 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, specifying the forgiving behaviour (see below).
addJSONFile(File) - Method in class com.docmosis.template.population.DataProviderBuilder: Add a JSON file to the existing data provider.
addJSONString(String) - Method in class com.docmosis.template.population.DataProviderBuilder: Add a JSON string to the existing data provider.
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.
addStringInterceptor(StringInterceptor) - Method in class com.docmosis.template.population.DataProviderBuilder: Add a StringInterceptor to this builder.
addStringInterceptor(StringInterceptor, boolean) - Method in class com.docmosis.template.population.DataProviderBuilder: Add a StringInterceptor to this builder.
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.
addXMLDocument(Document) - Method in class com.docmosis.template.population.DataProviderBuilder: Add an XML document to the existing data provider.
addXMLDocument(Document, XMLNodeFilter, boolean) - Method in class com.docmosis.template.population.DataProviderBuilder: Add an XML document to the existing data provider.
addXMLFile(File) - Method in class com.docmosis.template.population.DataProviderBuilder: Add an XML file to the existing data provider.
addXMLFile(File, boolean) - Method in class com.docmosis.template.population.DataProviderBuilder: Add an XML file to the existing data provider.
addXMLFile(File, XMLNodeFilter) - Method in class com.docmosis.template.population.DataProviderBuilder: Add an XML file to the existing data provider applying the given filter to selectively exclude some of the XML content.
addXMLFile(File, XMLNodeFilter, boolean) - Method in class com.docmosis.template.population.DataProviderBuilder: Add an XML file to the existing data provider applying the given filter to selectively exclude some of the XML content.
addXMLStream(InputStream, XMLNodeFilter, boolean) - Method in class com.docmosis.template.population.DataProviderBuilder: Add the given input stream to this data provider, optionally filtering out content using the given filter and optionally including the root node.
addXMLStream(InputSource, XMLNodeFilter, boolean) - Method in class com.docmosis.template.population.DataProviderBuilder: Add the given input source to this data provider, optionally filtering out content using the given filter and optionally including the root node.
addXMLString(String) - Method in class com.docmosis.template.population.DataProviderBuilder: Add the given XML string to this data provider.
addXMLString(String, XMLNodeFilter) - Method in class com.docmosis.template.population.DataProviderBuilder: Add the given XML string to this data provider, optionally filtering out content using the given filter.
addXMLString(String, XMLNodeFilter, boolean) - Method in class com.docmosis.template.population.DataProviderBuilder: Add the given XML string to this data provider, optionally filtering out content using the given filter and optionally including the root node.
ALL - Static variable in class com.docmosis.document.ExternalResourcePermissions: All permission granted
AlternatingTableRowRenderer - Class in com.docmosis.template.population.render: 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.
applyToConversionProperty(ConversionInstruction) - Method in class com.docmosis.document.converter.ConversionInstruction.PDFImageReduceResolutionSetting
ATTRIBUTE_BACKGROUND_COLOUR_CHARS - Static variable in class com.docmosis.template.analysis.TableCellStyle
ATTRIBUTE_BORDER_STYLE - Static variable in class com.docmosis.template.analysis.TableCellStyle
ATTRIBUTE_BORDER_STYLE_BOTTOM - Static variable in class com.docmosis.template.analysis.TableCellStyle
ATTRIBUTE_BORDER_STYLE_LEFT - Static variable in class com.docmosis.template.analysis.TableCellStyle
ATTRIBUTE_BORDER_STYLE_RIGHT - Static variable in class com.docmosis.template.analysis.TableCellStyle
ATTRIBUTE_BORDER_STYLE_TOP - Static variable in class com.docmosis.template.analysis.TableCellStyle

B

BarcodeException - Exception in com.docmosis.template.analysis.barcode
BarcodeException(String) - Constructor for exception com.docmosis.template.analysis.barcode.BarcodeException
BarcodeException(String, Throwable, String[]) - Constructor for exception com.docmosis.template.analysis.barcode.BarcodeException
BarcodeException(String, String[]) - Constructor for exception com.docmosis.template.analysis.barcode.BarcodeException
Base64ImageStringInterceptor - Class in com.docmosis.template.population.data: This interceptor will look for images in string values.
Base64ImageStringInterceptor(String, boolean, boolean, boolean) - Constructor for class com.docmosis.template.population.data.Base64ImageStringInterceptor: Create a new Base64 image-decoding interceptor.
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_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.
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 in com.docmosis.template.population.format: 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 in com.docmosis.template.population.render: 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
BootstrapException - Exception in com.sun.star.comp.helper: BootstrapException is a checked exception that wraps an exception thrown by the original target.
BootstrapException() - Constructor for exception com.sun.star.comp.helper.BootstrapException: Constructs a BootstrapException with null as the target exception.
BootstrapException(String) - Constructor for exception com.sun.star.comp.helper.BootstrapException: Constructs a BootstrapException with the specified detail message.
BootstrapException(String, Exception) - Constructor for exception com.sun.star.comp.helper.BootstrapException: Constructs a BootstrapException with the specified detail message and a target exception.
BootstrapException(Exception) - Constructor for exception com.sun.star.comp.helper.BootstrapException: Constructs a BootstrapException with a target exception.
borderStylesVary() - Method in class com.docmosis.template.analysis.TableCellStyle: Determine if the border style changes for this cell from row to row.

C

canHaveChildren() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement
canRetry() - Method in exception com.docmosis.document.ProcessingException: Determine if retrying the process might be viable.
CHANGES - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
CharacterConstants - Class in com.docmosis.document: Constants in this class are helpful for inserting special characters into documents.
CharacterConstants() - Constructor for class com.docmosis.document.CharacterConstants
Cleanable - Interface in com.docmosis.template.population: Identify an Object that may be cleaned up.
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
cleanup() - Method in class com.docmosis.template.population.XMLDataProvider
cleanupDataProvider() - Method in class com.docmosis.document.converter.ConversionInstruction: Determine if the DataProvider should be cleaned up at the end of the render process.
clearDefaultRendererByClass(Class) - Static method in class com.docmosis.template.population.render.RendererRegistry: Remove any renderer registered against the given class.
clearDefaultRendererByName(String) - Static method in class com.docmosis.template.population.render.RendererRegistry: Remove any renderer registered against the given name.
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.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.analysis.barcode - package com.docmosis.template.analysis.barcode
com.docmosis.template.analysis.fontmapping - package com.docmosis.template.analysis.fontmapping
com.docmosis.template.analysis.list - package com.docmosis.template.analysis.list
com.docmosis.template.analysis.openoffice.expression - package com.docmosis.template.analysis.openoffice.expression
com.docmosis.template.analysis.openoffice.fontmapping - package com.docmosis.template.analysis.openoffice.fontmapping
com.docmosis.template.analysis.sorting - package com.docmosis.template.analysis.sorting
com.docmosis.template.analysis.structure - package com.docmosis.template.analysis.structure
com.docmosis.template.population - package com.docmosis.template.population
com.docmosis.template.population.data - package com.docmosis.template.population.data
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
com.docmosis.template.store.database - package com.docmosis.template.store.database
com.sun.star.comp.helper - package com.sun.star.comp.helper
com.sun.star.uno - package com.sun.star.uno
CompoundDataProvider - Class in com.docmosis.template.population: A DataProvider that provides a "chain" of data providers.
CompoundDataProvider() - Constructor for class com.docmosis.template.population.CompoundDataProvider
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.
conditionalBegin(TemplateStructureElement) - Method in class com.docmosis.template.analysis.structure.JSONDummyDataTemplateStructureProcessor
conditionalBegin(TemplateStructureElement) - Method in class com.docmosis.template.analysis.structure.SimpleJSONTemplateStructureProcessor
conditionalBegin(TemplateStructureElement) - Method in interface com.docmosis.template.analysis.structure.TemplateStructureProcessor: Process the start of a conditional section
conditionalEnd(TemplateStructureElement) - Method in class com.docmosis.template.analysis.structure.JSONDummyDataTemplateStructureProcessor
conditionalEnd(TemplateStructureElement) - Method in class com.docmosis.template.analysis.structure.SimpleJSONTemplateStructureProcessor
conditionalEnd(TemplateStructureElement) - Method in interface com.docmosis.template.analysis.structure.TemplateStructureProcessor: Process the end of a conditional section
containsKey(Object) - Method in class com.docmosis.template.analysis.list.ListStyles
ConversionException - Exception in com.docmosis.document.converter
ConversionException() - Constructor for exception com.docmosis.document.converter.ConversionException
ConversionException(String) - Constructor for exception com.docmosis.document.converter.ConversionException
ConversionException(String, Throwable) - Constructor for exception com.docmosis.document.converter.ConversionException
ConversionException(Throwable) - Constructor for exception com.docmosis.document.converter.ConversionException
ConversionFormat - Class in com.docmosis.document.converter: This class specifies the available target formats for document production.
ConversionInstruction - Class in com.docmosis.document.converter: This class is used to specify various settings for a document to be rendered.
ConversionInstruction() - Constructor for class com.docmosis.document.converter.ConversionInstruction: Create a blank conversion instruction.
ConversionInstruction(ConversionInstruction) - Constructor for class com.docmosis.document.converter.ConversionInstruction: Create a standalone copy of the given conversion instruction.
ConversionInstruction.OfficeEngineProperties - Class in com.docmosis.document.converter: Properties specifically for the underlying office engine
ConversionInstruction.OfficeEngineProperties() - Constructor for class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
ConversionInstruction.PDFImageReduceResolutionSetting - Class in com.docmosis.document.converter
ConversionInstruction.PdfVersion - Enum in com.docmosis.document.converter
ConversionServiceFailureException - Exception in com.docmosis.document.converter
ConversionServiceFailureException() - Constructor for exception com.docmosis.document.converter.ConversionServiceFailureException
ConversionServiceFailureException(String, Throwable) - Constructor for exception com.docmosis.document.converter.ConversionServiceFailureException
ConversionServiceFailureException(String, Throwable, boolean) - Constructor for exception com.docmosis.document.converter.ConversionServiceFailureException
ConversionServiceFailureException(String) - Constructor for exception com.docmosis.document.converter.ConversionServiceFailureException
ConversionServiceFailureException(String, boolean) - Constructor for exception com.docmosis.document.converter.ConversionServiceFailureException
ConversionServiceFailureException(Throwable) - Constructor for exception com.docmosis.document.converter.ConversionServiceFailureException
convert(File, File[]) - Static method in class com.docmosis.document.DocumentConverter: Convert the given input file to the set of output files.
convert(File, File) - Static method in class com.docmosis.document.DocumentConverter: Convert the given input file to the given output file.
convert(File, File, ConversionInstruction) - Static method in class com.docmosis.document.DocumentConverter: Convert the given input file to the given output file.
convert(File, File, ConversionInstruction, ExternalResourcePermissions) - Static method in class com.docmosis.document.DocumentConverter: Convert the given input file to the given output file.
ConverterPoolException - Exception in com.docmosis.document.converter.pool
ConverterPoolException() - Constructor for exception com.docmosis.document.converter.pool.ConverterPoolException
ConverterPoolException(String) - Constructor for exception com.docmosis.document.converter.pool.ConverterPoolException
ConverterPoolException(String, Throwable) - Constructor for exception com.docmosis.document.converter.pool.ConverterPoolException
ConverterPoolException(Throwable) - Constructor for exception com.docmosis.document.converter.pool.ConverterPoolException
CoordinatedRenderResult - Class in com.docmosis.document: The results of a the render of a "coordinated" document (driven by a coordinator template).
CoordinatedRenderResult(long, int, boolean, TemplateIdentifier, boolean, boolean, boolean, boolean, String, boolean) - Constructor for class com.docmosis.document.CoordinatedRenderResult
CoordinatedRenderResult(DocumentRenderResult) - Constructor for class com.docmosis.document.CoordinatedRenderResult
CoordinatedRenderResults - Class in com.docmosis.document: The "coordinated" results of a document render.
CoordinatedRenderResults(List<CoordinatedRenderResult>) - Constructor for class com.docmosis.document.CoordinatedRenderResults
countSubstitutions() - Method in class com.docmosis.template.analysis.fontmapping.FontInfo: Count the number of font substitutions being made in this template.
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.
createUniqueTempTemplateIdentifier() - Static method in class com.docmosis.template.store.TemplateIdentifier: Create a unique template identifier, typically useful only for templates that are temporary in nature.
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

D

DATA_URI_SCHEME_BASE_64_EXTENSION - Static variable in class com.docmosis.template.population.data.Base64ImageStringInterceptor
DATA_URI_SCHEME_PREFIX - Static variable in class com.docmosis.template.population.data.Base64ImageStringInterceptor
DatabaseTemplateStoreTableStructureException - Exception in com.docmosis.template.store.database
DatabaseTemplateStoreTableStructureException() - Constructor for exception com.docmosis.template.store.database.DatabaseTemplateStoreTableStructureException
DatabaseTemplateStoreTableStructureException(String) - Constructor for exception com.docmosis.template.store.database.DatabaseTemplateStoreTableStructureException
DatabaseTemplateStoreTableStructureException(String, Throwable) - Constructor for exception com.docmosis.template.store.database.DatabaseTemplateStoreTableStructureException
dataFormatManager - Variable in class com.docmosis.template.population.ReflectiveDataProvider
DataFormatter - Interface in com.docmosis.template.population.format: This interface specifies the required signature for a class that can provide format facilities for values produced by DataProviders.
DataProvider - Interface in com.docmosis.template.population: The DataProvider interface marks classes that can provide data to the population phase of document production.
DataProviderBuilder - Class in com.docmosis.template.population: 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 in com.docmosis.template.population: A convenience class for creating, building and extending DataProviders to feed templates.
DataProviderFactory() - Constructor for class com.docmosis.template.population.DataProviderFactory
DataProviderGrouping - Interface in com.docmosis.template.population: Information for transforming a grid of data into a hierarchy.
DataProviderGroupingException - Exception in com.docmosis.template.population: A general exception for when data provider groupings are in an invalid state.
DataProviderGroupingException(String) - Constructor for exception com.docmosis.template.population.DataProviderGroupingException: Create a new exception.
DataProviderKeyException - Exception in com.docmosis.template.population: 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 exception com.docmosis.template.population.DataProviderKeyException: Create a new exception.
DataProviderKeyParser - Class in com.docmosis.template.population: A utility class to parse keys for data provider elements.
DataProviderKeyParser() - Constructor for class com.docmosis.template.population.DataProviderKeyParser
DataProviderSQLGrouping - Class in com.docmosis.template.population: 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.
DataProvisionFetchException - Exception in com.docmosis.template.population
DataProvisionFetchException(String, Throwable, Object, Class) - Constructor for exception com.docmosis.template.population.DataProvisionFetchException
DataProvisionNotFoundException - Exception in com.docmosis.template.population
DataProvisionNotFoundException(String, Object, Class) - Constructor for exception com.docmosis.template.population.DataProvisionNotFoundException
DateDataFormatter - Class in com.docmosis.template.population.format: 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 in com.docmosis.template.population.render: 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 in com.docmosis.template.population: 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
DEFAULT_PDF_CREATE_FORM - Static variable in class com.docmosis.document.converter.ConversionInstruction
delegateCollection - Variable in class com.docmosis.template.population.ReflectiveCollectionDataProvider
deleteAll() - Method in interface com.docmosis.template.store.TemplateStore: Delete all templates in the store.
deleteAll() - Method in class com.docmosis.template.store.TemplateStoreFactory.PresetTemplateStore
deleteTemplate(TemplateIdentifier) - Method in interface com.docmosis.template.store.TemplateStore: Delete the given template from the store.
deleteTemplate(TemplateIdentifier) - Method in class com.docmosis.template.store.TemplateStoreFactory.PresetTemplateStore
deleteTemplates(TemplateContext, boolean) - Method in interface com.docmosis.template.store.TemplateStore: Delete all templates in the given context.
deleteTemplates(TemplateContext, boolean) - Method in class com.docmosis.template.store.TemplateStoreFactory.PresetTemplateStore
deriveNewCopy(String) - Method in class com.docmosis.template.analysis.list.ListStyle: Derive a new complete copy of the style, with a new name.
Discriminator - Class in com.docmosis.template.population: 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.
DISPLAY_PDF_DOCUMENT_TITLE - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
Document - Interface in com.docmosis.template
DOCUMENT_OPEN_PASSWORD - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
DocumentConversionResult - Class in com.docmosis.document: The results of a document conversion
DocumentConversionResult(long, int, ExternalResourceCollection) - Constructor for class com.docmosis.document.DocumentConversionResult
DocumentConverter - Class in com.docmosis.document: This class provides conversion-only capabilities, exposing the ability to convert documents between formats, but not to merge with data.
DocumentConverter() - Constructor for class com.docmosis.document.DocumentConverter
DocumentProcessor - Class in com.docmosis.document: This class is the entry point for controlling the production of documents.
DocumentProcessor() - Constructor for class com.docmosis.document.DocumentProcessor
DocumentRenderResult - Class in com.docmosis.document: The results of a document render.
DocumentRenderResult(long, int, boolean, TemplateIdentifier, boolean) - Constructor for class com.docmosis.document.DocumentRenderResult
DocumentRenderResult(long, int, boolean, TemplateIdentifier, boolean, CoordinatedRenderResults) - Constructor for class com.docmosis.document.DocumentRenderResult
DPI_1200 - Static variable in class com.docmosis.document.converter.ConversionInstruction.PDFImageReduceResolutionSetting
DPI_150 - Static variable in class com.docmosis.document.converter.ConversionInstruction.PDFImageReduceResolutionSetting
DPI_300 - Static variable in class com.docmosis.document.converter.ConversionInstruction.PDFImageReduceResolutionSetting
DPI_600 - Static variable in class com.docmosis.document.converter.ConversionInstruction.PDFImageReduceResolutionSetting
DPI_75 - Static variable in class com.docmosis.document.converter.ConversionInstruction.PDFImageReduceResolutionSetting
DropStoreHelper - Class in com.docmosis.template.store: This class makes it easier to pick up documents in a directory, zip or jar and register them into the (configured) store.
DropStoreHelper(TemplateStore) - Constructor for class com.docmosis.template.store.DropStoreHelper: Create a new DropStoreHelper object.
DropStoreHelper(TemplateStore, ExternalResourcePermissions) - Constructor for class com.docmosis.template.store.DropStoreHelper: Create a new DropStoreHelper object.
dynamicStylingApplies() - Method in class com.docmosis.template.analysis.SimpleTemplateTableCell: Determine if dynamic styling can be applied to this cell.
dynamicStylingApplies() - Method in class com.docmosis.template.analysis.TableCellStyle: Determine if styling information can vary from row to row for this cell.

E

EMBED_STANDARD_FONTS - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
EMPTY_BOX_WINGDINGS - Static variable in class com.docmosis.document.CharacterConstants
ENABLE_COPYING_OF_CONTENT - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
ENABLE_TEXT_ACCESS_FOR_ACCESSIBILITY_TOOLS - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
ENCRYPT_FILE - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
equals(Object) - Method in class com.docmosis.document.converter.ConversionFormat
equals(Object) - Method in class com.docmosis.document.converter.ConversionInstruction
equals(Object) - Method in class com.docmosis.document.ExternalResourceCollection
equals(Object) - Method in class com.docmosis.document.ImageScalingDefault
equals(Object) - Method in class com.docmosis.template.analysis.fontmapping.FontInfo
equals(Object) - Method in class com.docmosis.template.analysis.fontmapping.FontMappingUseItem
equals(Object) - Method in class com.docmosis.template.analysis.SimpleTemplateTableCell
equals(Object, boolean) - Method in class com.docmosis.template.analysis.SimpleTemplateTableCell
equals(Object, boolean) - Method in class com.docmosis.template.analysis.SimpleTemplateTableRow
equals(Object, boolean) - Method in interface com.docmosis.template.analysis.TemplateSection: Determine if this object is equal to the given object optionally ignoring positional information.
equals(Object) - Method in class com.docmosis.template.analysis.TextWritableSafeAreas
equals(Object) - Method in class com.docmosis.template.analysis.TextWritableSafeAreas.ParagraphMapItem
equals(Object) - Method in class com.docmosis.template.population.Discriminator: Determine whether this object equals another.
equals(Object) - Method in class com.docmosis.template.population.SQLDataItem
equals(Object) - Method in class com.docmosis.template.store.TemplateContext
equals(Object) - Method in class com.docmosis.template.store.TemplateIdentifier
equals(Object) - Method in class com.docmosis.template.store.TemplateStoreFactory.PresetTemplateStore
equals(Object) - Method in class com.docmosis.template.TemplateDetails: Test for equality.
EXPORT_FORM_FIELDS - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
ExpressionFunctionException - Exception in com.docmosis.template.analysis.openoffice.expression
ExpressionFunctionException() - Constructor for exception com.docmosis.template.analysis.openoffice.expression.ExpressionFunctionException
ExpressionFunctionException(String, Throwable) - Constructor for exception com.docmosis.template.analysis.openoffice.expression.ExpressionFunctionException
ExpressionFunctionException(String) - Constructor for exception com.docmosis.template.analysis.openoffice.expression.ExpressionFunctionException
ExpressionFunctionException(String, boolean) - Constructor for exception com.docmosis.template.analysis.openoffice.expression.ExpressionFunctionException
ExpressionFunctionException(Throwable) - Constructor for exception com.docmosis.template.analysis.openoffice.expression.ExpressionFunctionException
ExtendedConversionInstruction - Class in com.docmosis.document.converter
ExtendedConversionInstruction() - Constructor for class com.docmosis.document.converter.ExtendedConversionInstruction
ExternalResourceCollection - Class in com.docmosis.document
ExternalResourceCollection(String[]) - Constructor for class com.docmosis.document.ExternalResourceCollection
ExternalResourcePermissions - Class in com.docmosis.document: Control of the allowed external resources in the form of a white list of urls or url-prefixes.
ExternalResourcePermissionsCheckResult - Class in com.docmosis.document
ExternalResourcePermissionsCheckResult(boolean, String) - Constructor for class com.docmosis.document.ExternalResourcePermissionsCheckResult

F

field(TemplateStructureElement) - Method in class com.docmosis.template.analysis.structure.JSONDummyDataTemplateStructureProcessor
field(TemplateStructureElement) - Method in class com.docmosis.template.analysis.structure.SimpleJSONTemplateStructureProcessor
field(TemplateStructureElement) - Method in interface com.docmosis.template.analysis.structure.TemplateStructureProcessor: Process a template field.
FIELD_IMAGE_BASE64_ADD_STRINGS - Static variable in class com.docmosis.template.population.data.Base64ImageStringInterceptor
FIELD_IMAGE_BASE64_ALLOW_FOR_DATA_URI_SCHEME - Static variable in class com.docmosis.template.population.data.Base64ImageStringInterceptor
FIELD_IMAGE_BASE64_ENCODED_PREFIX - Static variable in class com.docmosis.template.population.data.Base64ImageStringInterceptor
FIELD_IMAGE_BASE64_PROCESSING_TERMINUS - Static variable in class com.docmosis.template.population.data.Base64ImageStringInterceptor
FieldDetails - Class in com.docmosis.template.population.render: This object provides all the information about a field to be rendered.
FieldDetails(String, String, String, int, Class, Object, Class, Object, String, String[], DataProvider[], TemplateVariablesAccessor) - Constructor for class com.docmosis.template.population.render.FieldDetails
FieldRenderer - Interface in com.docmosis.template.population.render: This interface defines an object that can provide particular formatting features for a renderer.
FieldRendererException - Exception in com.docmosis.template.population.render
FieldRendererException(String) - Constructor for exception com.docmosis.template.population.render.FieldRendererException
FieldRendererException(Throwable) - Constructor for exception com.docmosis.template.population.render.FieldRendererException
FieldRendererException(String, Throwable) - Constructor for exception com.docmosis.template.population.render.FieldRendererException
FieldRendererException(String, Throwable, String) - Constructor for exception com.docmosis.template.population.render.FieldRendererException
fileNameMatchesFormat(String, ConversionFormat) - Static method in class com.docmosis.document.converter.ConversionFormat: Determine if the given file name matches the given format.
finalize() - Method in class com.docmosis.template.population.MemoryDataProvider
find(String, Set) - Method in class com.docmosis.template.analysis.list.ListTree: Starting from the given startingId, look for a parentId in the given set of acceptable ids.
findByClass(Class) - Method in class com.docmosis.template.population.render.RendererRegistry: Look for a renderer by Class first in this instance and if not found (or null returned) look in the default renderers.
findByContext(TemplateContext, boolean) - Method in interface com.docmosis.template.store.TemplateStore: Get the list of templates for the given context.
findByContext(TemplateContext, boolean) - Method in class com.docmosis.template.store.TemplateStoreFactory.PresetTemplateStore
findByName(String) - Method in class com.docmosis.template.population.render.RendererRegistry: Look for a renderer by name first in this instance and if not found (or null returned) look in the default renderers.
finish() - Method in class com.docmosis.template.analysis.structure.JSONDummyDataTemplateStructureProcessor
finish() - Method in class com.docmosis.template.analysis.structure.SimpleJSONTemplateStructureProcessor
finish() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureProcessor: Perform processing for the end of the template structure.
finish() - Method in class com.docmosis.template.analysis.TextWritableSafeAreas: Finish and optimise for runtime rendering.
FIT - Static variable in class com.docmosis.document.ImageScalingDefault: Use this constant to specify default images should scale to fit preserving aspect ratio
FontInfo - Class in com.docmosis.template.analysis.fontmapping
FontInfo(FontMappingUseItem[]) - Constructor for class com.docmosis.template.analysis.fontmapping.FontInfo
FontInfoExtractorException - Exception in com.docmosis.template.analysis.openoffice.fontmapping
FontInfoExtractorException() - Constructor for exception com.docmosis.template.analysis.openoffice.fontmapping.FontInfoExtractorException
FontInfoExtractorException(String) - Constructor for exception com.docmosis.template.analysis.openoffice.fontmapping.FontInfoExtractorException
FontInfoExtractorException(Throwable) - Constructor for exception com.docmosis.template.analysis.openoffice.fontmapping.FontInfoExtractorException
FontInfoExtractorException(String, Throwable) - Constructor for exception com.docmosis.template.analysis.openoffice.fontmapping.FontInfoExtractorException
FontMappingUseItem - Class in com.docmosis.template.analysis.fontmapping: Java representation of the struct used for font mappings in LO.
FontMappingUseItem(String, String[], int) - Constructor for class com.docmosis.template.analysis.fontmapping.FontMappingUseItem
forgiving - Variable in class com.docmosis.template.population.ReflectiveDataProvider
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.
format(Class, Object, String, Class) - Method in class com.docmosis.template.population.ReflectiveDataProvider.DataFormatManager
FORMAT_CSV - Static variable in class com.docmosis.document.converter.ConversionFormat
FORMAT_DOCX - Static variable in class com.docmosis.document.converter.ConversionFormat: Specify DOCX as the format
FORMAT_FODT - Static variable in class com.docmosis.document.converter.ConversionFormat: Specify FODT (Flat Open Document Text) as the format
FORMAT_HTML - Static variable in class com.docmosis.document.converter.ConversionFormat: Specify HTML as the format.
FORMAT_JPG - Static variable in class com.docmosis.document.converter.ConversionFormat
FORMAT_ODG - Static variable in class com.docmosis.document.converter.ConversionFormat
FORMAT_ODP - Static variable in class com.docmosis.document.converter.ConversionFormat
FORMAT_ODS - Static variable in class com.docmosis.document.converter.ConversionFormat
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_PNG - Static variable in class com.docmosis.document.converter.ConversionFormat
FORMAT_PPT - Static variable in class com.docmosis.document.converter.ConversionFormat
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
FORMAT_XHTML - Static variable in class com.docmosis.document.converter.ConversionFormat: Specify XHTML as the format
FORMAT_XLS - Static variable in class com.docmosis.document.converter.ConversionFormat
FORMAT_XLSX - Static variable in class com.docmosis.document.converter.ConversionFormat
fromParamString(String) - Static method in enum com.docmosis.document.converter.ConversionInstruction.PdfVersion: Obtain from a parameter string.
fromPath(String) - Static method in class com.docmosis.template.store.TemplateIdentifier: Construct a TemplateIdentifier from a full path to a template (template an context combined).

G

get(int) - Method in class com.docmosis.document.CoordinatedRenderResults
get(String) - Method in class com.docmosis.template.analysis.list.ListStyles
getAlternateExtension() - Method in class com.docmosis.document.converter.ConversionFormat: Get the alternate file extension of this format if any.
getAnalysis() - Method in interface com.docmosis.template.Template
getAnalysis() - Method in class com.docmosis.template.TemplateDetails: Get the analysis for this template.
getBaseStyleName() - Method in class com.docmosis.template.analysis.TableCellStyle
getBgColourEven() - Method in class com.docmosis.template.analysis.TableCellStyle
getBgColourOdd() - Method in class com.docmosis.template.analysis.TableCellStyle
getBold() - Method in class com.docmosis.template.population.render.RenderedField: Determine whether to add the bold font attribute.
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.
getBooleanKeys() - Method in class com.docmosis.template.population.MemoryDataProvider: Get all of the available keys representing any boolean values.
getBooleanValue() - Method in class com.docmosis.template.population.SQLDataItem: Return the boolean value of this item.
getBorderStyles() - Method in class com.docmosis.template.analysis.TableCellStyle
getCause() - Method in exception org.json.com.docmosis.JSONException
getClassName() - Static method in class com.docmosis.document.converter.RemoteConverterTerminus: Deprecated.
getCloseParaHeadingSequence() - Method in interface com.docmosis.template.analysis.TemplateField: Get the sequence (of tags) required to close the nearest paragraph or heading in the content hierarchy.
getColumns() - Method in class com.docmosis.template.population.Discriminator: Return columns used for this discriminator.
getColumnsSpanned() - Method in class com.docmosis.template.analysis.SimpleTemplateTableCell
getCombinedMemSize() - Method in class com.docmosis.template.analysis.ImageAnalysis: Return the combined in-memory size of all images in bytes.
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.
getContainingCell() - Method in interface com.docmosis.template.analysis.TemplateField: Get the containing table cell (if applicable) of this field.
getContainingNest() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement: Get the containing nesting structure for this element.
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.
getConversionInstruction() - Method in class com.docmosis.document.RenderRequest: Get the conversion instruction to use for this request.
getConversionProperties(ConversionFormat) - Method in class com.docmosis.document.converter.ConversionInstruction
getConversionSettings() - Method in class com.docmosis.document.RenderRequest
getConverterGroupName() - Method in class com.docmosis.document.converter.ConversionInstruction: Get the name of the Converter Group to use to render the document.
getCoordinatedResults() - Method in class com.docmosis.document.CoordinatedRenderResults: Get the list coordinated renders if any.
getCoordinatedResults() - Method in class com.docmosis.document.DocumentRenderResult: Get the list coordinated renders if any.
getCount() - Method in class com.docmosis.template.analysis.fontmapping.FontMappingUseItem: Count of each render of a piece of text.
getDataItem(String) - Method in class com.docmosis.template.population.SQLDataProvider
getDataLookups() - Method in class com.docmosis.template.analysis.structure.TemplateExpression
getDataProvider() - Method in class com.docmosis.document.RenderRequest: Get the data provider to use
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.
getDataProviderKeys() - Method in class com.docmosis.template.population.MemoryDataProvider: Get all of the available keys representing any data providers.
getDataProviderLineage() - Method in class com.docmosis.template.population.render.FieldDetails: Get the lineage of DataProviders starting with the data provider that contains the current value, then the parent DataProvider, then the grand parent etc.
getDefaultExternalResourcePermission() - Static method in class com.docmosis.template.store.StoreHelper
getDefaultInstance() - Static method in class com.docmosis.template.population.data.Base64ImageStringInterceptor
getDefaultRendererByClass(Class) - Static method in class com.docmosis.template.population.render.RendererRegistry: Get the default renderer for the given class.
getDefaultRendererByName(String) - Static method in class com.docmosis.template.population.render.RendererRegistry
getDelegate() - Method in class com.docmosis.template.population.ReflectiveDataProvider: Return the delegate inside this Reflective Data Provider.
getDepth() - Method in class com.docmosis.template.analysis.ImageAnalysis.ImageDetail
getDerivedStyles() - Method in class com.docmosis.template.analysis.list.ListStyles: Get a list of the styles that have been derived.
getDetailedMessage() - Method in exception com.docmosis.template.population.render.FieldRendererException
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.
getEndIdx() - Method in class com.docmosis.template.analysis.TextWritableSafeAreas.ParagraphMapItem
getEndIndex() - Method in interface com.docmosis.template.analysis.TemplateSection: Get the index into the content of the last character of this section
getErrorInsertionIndex() - Method in exception com.docmosis.template.TemplateParseException: If set, this indicates a good location in the template to insert an error message.
getErrors() - Method in class com.docmosis.template.TemplateValidationResult
getExpression() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement: Get any template-expression associated with this field.
getExpressionText() - Method in class com.docmosis.template.analysis.structure.TemplateExpression
getExtension() - Method in class com.docmosis.document.converter.ConversionFormat: Get the typical file extension of this format.
getExternalResourcePermissions() - Method in class com.docmosis.document.RenderRequest
getExternalResources() - Method in class com.docmosis.document.DocumentConversionResult: Get the external resource references detected in the document.
getExternalResources() - Method in interface com.docmosis.template.analysis.TemplateAnalysis: Get the external resource references detected in the template.
getFieldName() - Method in interface com.docmosis.template.analysis.TemplateField: Get the name of the field.
getFieldName() - Method in class com.docmosis.template.population.render.FieldDetails: Get the name of the field.
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.
getFieldValue() - Method in class com.docmosis.template.population.render.FieldDetails: Get the value to be displayed.
getFirstFailedResource() - Method in class com.docmosis.document.ExternalResourcePermissionsCheckResult
getFirstRowStyle() - Method in class com.docmosis.template.analysis.TableCellStyle.RepeatingRowTopAndBottomBorderStyles
getFontInfo() - Method in interface com.docmosis.template.analysis.TemplateAnalysis: Get the font mappings associated with this template.
getFontMappings() - Method in class com.docmosis.template.analysis.fontmapping.FontInfo
getForceInternalConverterForDocXTemplates() - Method in class com.docmosis.document.converter.ExtendedConversionInstruction
getFormat(String) - Static method in class com.docmosis.document.converter.ConversionFormat: Get the format matching the given extension (eg "pdf") in a case-insensitive manner.
getFormatArray(String) - Static method in class com.docmosis.document.converter.ConversionFormat: Get the formats matching the given comma separated list of extensions (eg "pdf,doc") in a case-insensitive manner.
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.
getFullPath() - Method in class com.docmosis.template.store.TemplateIdentifier: Return the context plus name as a path (/)
getHeight() - Method in class com.docmosis.template.analysis.ImageAnalysis.ImageDetail
getId() - Method in interface com.docmosis.template.analysis.TemplateField: Get the id for this field if one was specified in the template.
getId() - Method in class com.docmosis.template.population.render.FieldDetails: Get the id for this field if one was specified in the template.
getId() - Method in interface com.docmosis.template.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, String) - Method in interface com.docmosis.template.population.ImageSupplier: Get an image for the given key and value.
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.
getImageKeys() - Method in class com.docmosis.template.population.MemoryDataProvider: Get all of the available keys representing any images.
getImages() - Method in class com.docmosis.template.analysis.ImageAnalysis
getImageScalingDefault() - Method in class com.docmosis.document.RenderRequest: Get the default image scaling if specified, otherwise the system default is returned.
getImageStream() - Method in class com.docmosis.template.population.ImageSupplierInfo: Get the input stream of the image.
getImageSupplier() - Method in class com.docmosis.document.RenderRequest
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.
getIntermediateRowStyle() - Method in class com.docmosis.template.analysis.TableCellStyle.RepeatingRowTopAndBottomBorderStyles
getItalic() - Method in class com.docmosis.template.population.render.RenderedField: Determine whether to add the italic font attribute.
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.
getLastRowStyle() - Method in class com.docmosis.template.analysis.TableCellStyle.RepeatingRowTopAndBottomBorderStyles
getLeftBorderStyle() - Method in class com.docmosis.template.analysis.SimpleTemplateTableRow
getLength() - Method in class com.docmosis.document.DocumentConversionResult: Get the length of the resulting conversion (in bytes).
getLength() - Method in interface com.docmosis.template.analysis.TemplateAnalysis: Obtain the total size of the analysis stream.
getLength() - Method in interface com.docmosis.template.analysis.TemplateSection: Determine the length of this section of the template (end - start)
getLength() - Method in interface com.docmosis.template.Document
getListStyles() - Method in interface com.docmosis.template.analysis.TemplateAnalysis: Get a map of the list styles that are useful in population.
getListTree() - Method in interface com.docmosis.template.analysis.TemplateAnalysis: Get the ListTree describing relationships between numbered lists in the template
getMemSize(String) - Method in class com.docmosis.template.analysis.ImageAnalysis: Determine the memory used by the image by the given name.
getMemSize(ImageAnalysis, String) - Static method in class com.docmosis.template.analysis.ImageAnalysis: Determine the memory used by the image by the given name in the given analysis
getMessage() - Method in class com.docmosis.template.analysis.MessageAndSuggestions: Get the message indicating an issue
getMetaAnalysis() - Method in interface com.docmosis.template.analysis.TemplateAnalysis: Get the analysis of the Meta of the template.
getMode() - Method in enum com.docmosis.document.converter.ConversionInstruction.PdfVersion
getName() - Method in class com.docmosis.template.analysis.ImageAnalysis.ImageDetail
getName() - Method in class com.docmosis.template.analysis.list.ListStyle
getName() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement
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.
getNewFileName() - Method in class com.docmosis.document.CoordinatedRenderResult: Get the specified name (if any) of a new file request.
getNextWritableLocation(long, long) - Method in class com.docmosis.template.analysis.TextWritableSafeAreas: Get the next safe-to-write location starting from the given start and up to the given end.
getNextWritableLocation(long, long, boolean) - Method in class com.docmosis.template.analysis.TextWritableSafeAreas: Get the next safe-to-write location starting from the given start and up to the given end, optionally only returning areas that are not within frames.
getnRepeats() - Method in class com.docmosis.template.analysis.structure.JSONDummyDataTemplateStructureProcessor
getOnlineConverterCount() - Static method in class com.docmosis.document.DocumentProcessor: Get the number of converters online for the default converter pool group.
getOnlineConverterCount(String) - Static method in class com.docmosis.document.DocumentProcessor: Get the number of converters online for the named converter pool group.
getOnlyRowStyle() - Method in class com.docmosis.template.analysis.TableCellStyle.RepeatingRowTopAndBottomBorderStyles
getOpenParaHeadingSequence() - Method in interface com.docmosis.template.analysis.TemplateField: Get the sequence (of tags) required to open the nearest paragraph or heading in the content hierarchy.
getOrigBgColour() - Method in class com.docmosis.template.analysis.TableCellStyle
getOrigBottomBorder() - Method in class com.docmosis.template.analysis.TableCellStyle
getOriginalFieldText() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement: Get the original text of the element from the template
getOriginalFont() - Method in class com.docmosis.template.analysis.fontmapping.FontMappingUseItem: The original font specidied in the template.
getOriginalLastModified() - Method in class com.docmosis.template.TemplateDetails: Get the time (in milliseconds since the epoch) since the original template was last updated.
getOriginalLeftBorder() - Method in class com.docmosis.template.analysis.TableCellStyle
getOriginalMD5() - Method in interface com.docmosis.template.analysis.TemplateAnalysis: The the MD5 hash string that the template had at the time of storing.
getOriginalRightBorder() - Method in class com.docmosis.template.analysis.TableCellStyle
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().
getOriginalTemplate(TemplateIdentifier) - Method in class com.docmosis.template.store.TemplateStoreFactory.PresetTemplateStore
getOriginalTopBottomBorder() - Method in class com.docmosis.template.analysis.TableCellStyle
getOrigTopBorder() - Method in class com.docmosis.template.analysis.TableCellStyle
getOutputFile() - Method in class com.docmosis.document.RenderRequest: Get the output file specified.
getOutputFileName() - Method in class com.docmosis.document.converter.ConversionInstruction
getOutputFileNameWithFormats() - Method in class com.docmosis.document.converter.ConversionInstruction: Determine the default output file name that will be produced based on: outputFileName conversionFormats compressSingleDocument The effect is to ensure the default outputName has the correct extension based on what will be generated (".zip" for multiple files or compressing single format, otherwise the extension for the type).
getOutputStream() - Method in class com.docmosis.document.RenderRequest: Determine where to stream the result.
getPageCount() - Method in class com.docmosis.document.DocumentConversionResult: Get the page count of the file(s) converted.
getParentRow() - Method in class com.docmosis.template.analysis.SimpleTemplateTableCell: Return the parent row containing this cell.
getParsedFieldDetails() - Method in interface com.docmosis.template.analysis.TemplateSection: Get the parsed details for this field.
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.
getPopulationErrorsFatal() - Method in class com.docmosis.document.RenderRequest: Determine if population errors are fatal
getPostAmbleStartIdx() - Method in interface com.docmosis.template.analysis.TemplateSection: Get the start index of the post amble.
getPostStyleName() - Method in class com.docmosis.template.analysis.TableCellStyle: Return the section of xml immediately after the style name.
getPreAmbleEndIdx() - Method in interface com.docmosis.template.analysis.TemplateSection: Get the end index of the pre amble.
getPrefixText() - Method in class com.docmosis.template.analysis.list.ListStyle
getPreStyleName() - Method in class com.docmosis.template.analysis.TableCellStyle: Get the pre-style name section of xml.
getProcessedAllowingPaddedFields() - Method in interface com.docmosis.template.analysis.TemplateAnalysis: Determine if this template was processed allowing fields to be padded (eg << abc >>)
getProcessedWithExternalConverter() - Method in interface com.docmosis.template.analysis.TemplateAnalysis: Determine if this template was processed with the external converter
getProcessStylesInText() - Method in class com.docmosis.document.RenderRequest: Determine whether text data will be parsed for html-like styling.
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.
getReflectedDelegate() - Method in exception com.docmosis.template.population.DataProvisionFetchException
getReflectedDelegate() - Method in exception com.docmosis.template.population.DataProvisionNotFoundException
getReflectedDelegateClass() - Method in exception com.docmosis.template.population.DataProvisionFetchException
getReflectedDelegateClass() - Method in exception com.docmosis.template.population.DataProvisionNotFoundException
getRemainder() - Method in class com.docmosis.template.analysis.TableCellStyle: Return the remaining (static) xml portion of the style.
getRemoveTemplateAfterUse() - Method in class com.docmosis.document.RenderRequest: Determine if "remove template after use" is specified.
getRendererByClass(Class) - Method in class com.docmosis.template.population.render.RendererRegistry
getRendererByName(String) - Method in class com.docmosis.template.population.render.RendererRegistry
getRendererName() - Method in interface com.docmosis.template.analysis.TemplateField: Get the name of the renderer for this field.
getRendererName() - Method in class com.docmosis.template.population.render.FieldDetails: Get the name of the renderer.
getRendererParams() - Method in interface com.docmosis.template.analysis.TemplateField: Return any renderer parameters the field specifies.
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.
getResources() - Method in class com.docmosis.document.ExternalResourceCollection: Get the URLs
getRightBorderStyle() - Method in class com.docmosis.template.analysis.SimpleTemplateTableRow
getRowNum() - Method in class com.docmosis.template.population.render.FieldDetails: Get the row number if in a repeating table.
getRowsSpanned() - Method in class com.docmosis.template.analysis.SimpleTemplateTableCell
getSectionNameOverride() - Method in interface com.docmosis.template.analysis.TemplateField: Get the name of the section override.
getSections() - Method in interface com.docmosis.template.analysis.TemplateAnalysis: Get the breakdown of a template as a set of sections.
getSensitivityLabelInfo() - Method in interface com.docmosis.template.analysis.TemplateAnalysis: Get the sensitivity labels associated with this templates original source (if docx).
getSize() - Method in class com.docmosis.template.TemplateDetails: Get the size of this template.
getStartIdx() - Method in class com.docmosis.template.analysis.TextWritableSafeAreas.ParagraphMapItem
getStartIndex() - Method in interface com.docmosis.template.analysis.TemplateSection: Get the index into the content of the first character of this section
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 with default settings.
getStore(boolean, String, String, boolean) - Static method in class com.docmosis.template.store.TemplateStoreFactory: Get an instance of a TemplateStore which has default settings for the plain text field delimiters and whether errors in the template are fatal.
getStore(boolean, String, String, boolean, PropertiesProvider) - Static method in class com.docmosis.template.store.TemplateStoreFactory: Get an instance of a TemplateStore which has specified settings for the plain text field delimiters and whether errors in the template are fatal.
getStore(boolean) - Static method in class com.docmosis.template.store.TemplateStoreFactory: Get an instance of a TemplateStore which has default settings for the plain text field delimiters, specifying whether errors in the template are fatal.
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.
getStringInterceptors() - Method in class com.docmosis.template.population.DataProviderBuilder: Return the currently active list of String Interceptors.
getStringKeys() - Method in class com.docmosis.template.population.MemoryDataProvider: Get all of the available keys representing any string values.
getStructure() - Method in class com.docmosis.template.analysis.structure.TemplateStructureExtractor: Get the recursive structure which is a List of TemplateStructureElements.
getStructureFromDefaultStore(TemplateIdentifier) - Static method in class com.docmosis.template.analysis.structure.TemplateStructureExtractor: This is a convenience method to extract the TemplateStructure for the given template from the default template store.
getStyle() - Method in class com.docmosis.template.analysis.SimpleTemplateTableCell
getStyleAnalysis() - Method in interface com.docmosis.template.analysis.TemplateAnalysis: Get the analysis of the styles of the template.
getStyleNameEndIdx() - Method in class com.docmosis.template.analysis.SimpleTemplateTableCell
getStyleNameStartIdx() - Method in class com.docmosis.template.analysis.SimpleTemplateTableCell
getStyleRegistry() - Method in interface com.docmosis.template.analysis.TemplateAnalysis: Get the register of styles found during analysis.
getSubSections() - Method in interface com.docmosis.template.analysis.TemplateSection: Get the sections contained by this section.
getSubstitutions() - Method in class com.docmosis.template.analysis.fontmapping.FontInfo: Get an array of font mappings where substitutions are being made.
getSubStructures() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement
getSuffixText() - Method in class com.docmosis.template.analysis.list.ListStyle
getSuggestions() - Method in exception com.docmosis.template.analysis.barcode.BarcodeException
getSuggestions() - Method in class com.docmosis.template.analysis.MessageAndSuggestions: Get any suggestions which may help resolve the problem
getSuggestions() - Method in exception com.docmosis.template.TemplateParseException
getTableCellBackgroundColour() - Method in class com.docmosis.template.population.render.RenderedField: Get the background cell colour.
getTargetException() - Method in exception com.sun.star.comp.helper.BootstrapException: Get the thrown target exception.
getTemplate(TemplateIdentifier) - Method in interface com.docmosis.template.store.TemplateStore: Get the (working) template identified by the given templateId.
getTemplate(TemplateIdentifier) - Method in class com.docmosis.template.store.TemplateStoreFactory.PresetTemplateStore
getTemplateAnalysis(TemplateIdentifier) - Method in interface com.docmosis.template.store.TemplateStore: Get the template analysis for the template identified by the given template info.
getTemplateAnalysis(TemplateIdentifier) - Method in class com.docmosis.template.store.TemplateStoreFactory.PresetTemplateStore
getTemplateErrorMessages() - Method in interface com.docmosis.template.analysis.TemplateAnalysis: Get the error messages from the template (if any).
getTemplateFile() - Method in class com.docmosis.document.RenderRequest: Get the template file specified
getTemplateIdentifier() - Method in class com.docmosis.document.RenderRequest: Get the specified template identifier indicating the template to use.
getTemplateImages() - Method in interface com.docmosis.template.analysis.TemplateAnalysis: Get information about the images in the template.
getTemplateStore() - Method in class com.docmosis.document.RenderRequest: Get the template store.
getTemplateStoredTime(TemplateIdentifier) - Method in interface com.docmosis.template.store.TemplateStore: Return the time that the template was stored in this template store.
getTemplateStoredTime(TemplateIdentifier) - Method in class com.docmosis.template.store.TemplateStoreFactory.PresetTemplateStore
getTemplateStream() - Method in class com.docmosis.document.RenderRequest: Get the template stream setting.
getTemplateVariable(String) - Method in class com.docmosis.template.population.render.FieldDetails: Get a template variable value at the point of processing when the related renderer has been called.
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 attribute.
getUsedFonts() - Method in class com.docmosis.template.analysis.fontmapping.FontMappingUseItem: The first element is the font selected based on FontMappingUseItem.originalFont, this will usually be the FontMappingUseItem.originalFont if it is present.
getValue() - Method in class com.docmosis.document.ImageScalingDefault
getValue() - Method in class com.docmosis.template.population.render.RenderedField: Get the text value to display.
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).
getVersion() - Static method in class com.docmosis.SystemManager: Get the version of this Docmosis build.
getWidth() - Method in class com.docmosis.template.analysis.ImageAnalysis.ImageDetail
getWordFormats() - Static method in class com.docmosis.document.converter.ConversionFormat: Get the conversion formats that are word formats (doc,docx variants).
getWrappedInstance(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.
getWritableLocation(long) - Method in class com.docmosis.template.analysis.TextWritableSafeAreas: Determine if the given idx points to a safe-to-write location and if so return information about it.
getWritableSafeAreas() - Method in interface com.docmosis.template.analysis.TemplateAnalysis: Get the writable safe areas for validation
GroupedSQLDataProviderPopulator - Class in com.docmosis.template.population: A class responsible for plugging data into a data provider given an SQL Result Set and a data provider grouping.

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.
hasCorrectExtension(String, ConversionFormat) - Static method in class com.docmosis.document.converter.ConversionFormat: Determine if the given file name has the correct extension for the given format.
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.
hasErrors() - Method in class com.docmosis.template.TemplateValidationResult
hasExternalResourcesPermisionFailures() - Method in interface com.docmosis.template.analysis.TemplateAnalysis
hasFieldStyleOverride() - Method in interface com.docmosis.template.analysis.TemplateAnalysis
hasFrameAncestor() - Method in class com.docmosis.template.analysis.TextWritableSafeAreas.ParagraphMapItem
hashCode() - Method in class com.docmosis.document.converter.ConversionFormat
hashCode() - Method in class com.docmosis.document.converter.ConversionInstruction
hashCode() - Method in class com.docmosis.document.ExternalResourceCollection
hashCode() - Method in class com.docmosis.document.ImageScalingDefault
hashCode() - Method in class com.docmosis.template.analysis.fontmapping.FontInfo
hashCode() - Method in class com.docmosis.template.analysis.fontmapping.FontMappingUseItem
hashCode() - Method in class com.docmosis.template.analysis.SimpleTemplateTableCell
hashCode() - Method in class com.docmosis.template.analysis.SimpleTemplateTableRow
hashCode() - Method in class com.docmosis.template.analysis.TextWritableSafeAreas
hashCode() - Method in class com.docmosis.template.analysis.TextWritableSafeAreas.ParagraphMapItem
hashCode() - Method in class com.docmosis.template.population.Discriminator
hashCode() - Method in class com.docmosis.template.population.SQLDataItem
hashCode() - Method in class com.docmosis.template.store.TemplateContext
hashCode() - Method in class com.docmosis.template.store.TemplateIdentifier
hashCode() - Method in class com.docmosis.template.store.TemplateStoreFactory.PresetTemplateStore
hashCode() - Method in class com.docmosis.template.TemplateDetails
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.
hasShapeAncestor() - Method in class com.docmosis.template.analysis.TextWritableSafeAreas.ParagraphMapItem
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.
hasSubstitutions() - Method in class com.docmosis.template.analysis.fontmapping.FontInfo: True if this mapping is substituting the #originalFont with a different font.
hasTableWithMergedNonBreakingRows() - Method in interface com.docmosis.template.analysis.TemplateAnalysis: Determine if tables are present with merged rows and the "don't-break row" property set.
hasTemplateErrors() - Method in interface com.docmosis.template.analysis.TemplateAnalysis: Determine if the template has errors in it.
hasTOC() - Method in interface com.docmosis.template.analysis.TemplateAnalysis: Determine if the template has a Table of Contents (TOC)
HIDE_VIEWER_MENUBAR - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
HIDE_VIEWER_TOOLBAR - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
HIDE_VIEWER_WINDOW_CONTROLS - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties

I

image(TemplateStructureElement) - Method in class com.docmosis.template.analysis.structure.JSONDummyDataTemplateStructureProcessor
image(TemplateStructureElement) - Method in class com.docmosis.template.analysis.structure.SimpleJSONTemplateStructureProcessor
image(TemplateStructureElement) - Method in interface com.docmosis.template.analysis.structure.TemplateStructureProcessor: Process a template image
ImageAnalysis - Class in com.docmosis.template.analysis
ImageAnalysis() - Constructor for class com.docmosis.template.analysis.ImageAnalysis
ImageAnalysis.ImageDetail - Class in com.docmosis.template.analysis
ImageAnalysis.ImageDetail(String, long, int, int, int) - Constructor for class com.docmosis.template.analysis.ImageAnalysis.ImageDetail
ImageScalingDefault - Class in com.docmosis.document: This class provides constants for the types of image scaling available when images are inserted into a template.
ImageSupplier - Interface in com.docmosis.template.population: This interface marks an ImageSupplier which can be used to obtain images on the fly.
ImageSupplier.ImageSupplierException - Exception in com.docmosis.template.population
ImageSupplier.ImageSupplierException(String) - Constructor for exception com.docmosis.template.population.ImageSupplier.ImageSupplierException
ImageSupplier.ImageSupplierException(String, Throwable) - Constructor for exception com.docmosis.template.population.ImageSupplier.ImageSupplierException
ImageSupplierInfo - Class in com.docmosis.template.population: Information about the supply of an image.
ImageSupplierInfo(boolean, InputStream) - Constructor for class com.docmosis.template.population.ImageSupplierInfo: Create a new set of details about the image supplied
includesFormat(ConversionFormat) - Method in class com.docmosis.document.converter.ConversionInstruction: Determine if the specified format is included in the conversion formats currently set in this instruction.
INITIAL_VIEW - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
initialise() - Static method in class com.docmosis.SystemManager: Initialise the system from configuration files and System properties.
initialise(Configuration) - Static method in class com.docmosis.SystemManager: Initialise the system from the configuration as well as default configuration files and System properties.
initialise() - Static method in class com.docmosis.template.population.render.RendererRegistry
initialise() - Static method in class com.docmosis.template.store.TemplateStoreFactory: Initialise the Template Store factory.
initialize() - Method in class com.docmosis.document.converter.RemoteConverter
isAllColumnsLeftConditional() - Method in class com.docmosis.template.analysis.SimpleTemplateTableCell
isAllColumnsRightConditional() - Method in class com.docmosis.template.analysis.SimpleTemplateTableCell
isAnalysisCorruptError() - Method in exception com.docmosis.template.TemplateStoreException
isArtificial() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement: Determine if the element is artificially created by analysis processing.
isArtificial() - Method in interface com.docmosis.template.analysis.TemplateSection: Determine if this section is artificial, meaning it was created by Docmosis during analysis to assist with population.
isAssertionFailure() - Method in exception com.docmosis.template.TemplateParseException
isBarcode() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement
isBooleanItem() - Method in class com.docmosis.template.population.SQLDataItem: Determine if this object is a boolean item.
isClientError() - Method in exception com.docmosis.template.population.StringInterceptorException
isCompressingSingleDocument() - Method in class com.docmosis.document.converter.ConversionInstruction: Determine if a single resulting document should be automatically zipped to create a smaller file.
isConditional() - Method in interface com.docmosis.template.analysis.TemplateSection: Determine if this section is conditional
isConditionalSection() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement
isContainer() - Method in interface com.docmosis.template.analysis.TemplateSection: Determine if this section is a container section (meaning it can contain other sections).
isConvertOnly() - Method in class com.docmosis.document.converter.ConversionInstruction: Determine if this instruction is flagged as "convert only" meaning extra processing (such as updating TOC and counting pages) is not done.
isCoordinatedRender() - Method in class com.docmosis.document.DocumentRenderResult
isCoordinatorTemplate() - Method in interface com.docmosis.template.analysis.TemplateAnalysis
isDerived() - Method in class com.docmosis.template.analysis.list.ListStyle
isDueToServiceFailure - Variable in exception com.docmosis.document.converter.ConversionException
isDueToServiceFailure() - Method in exception com.docmosis.document.converter.ConversionException
isExpression() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement
isField() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement
isForgiving() - Method in class com.docmosis.template.population.ReflectiveDataProvider: Determine if this instance is forgiving or not.
isFormField() - Method in interface com.docmosis.template.analysis.TemplateField: Determine if this field is a form field (for a fillable PDF form for example).
isFunctionCall() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement
isGroupItems() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement
isHtmlRef() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement
isHyperlink() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement
isImage() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement
isImageSupplied() - Method in class com.docmosis.template.population.ImageSupplierInfo: Determine if the image is supplied.
isIncludeImages() - Method in class com.docmosis.template.analysis.structure.JSONDummyDataTemplateStructureProcessor
isInHeaderOrFooter() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement
isInitialized() - Static method in class com.docmosis.SystemManager: Determine if the system has been initialised.
isInSpan() - Method in class com.docmosis.template.analysis.TextWritableSafeAreas.ParagraphMapItem
isIntentional() - Method in exception com.docmosis.template.analysis.openoffice.expression.ExpressionFunctionException
isKeepRowTogetherStyleSet() - Method in class com.docmosis.template.analysis.SimpleTemplateTableRow
isNewFileRequested() - Method in class com.docmosis.document.CoordinatedRenderResult: Determine if the coordinator template has requested a new file at this point in the coordination.
isOutsideParagraph() - Method in exception com.docmosis.template.TemplateParseException
isPadToEvenPageRequested() - Method in class com.docmosis.document.CoordinatedRenderResult: Determine whether the coordinator template specified that padding to an even page has been requested at this point in the coordination.
isPadToOddPageRequested() - Method in class com.docmosis.document.CoordinatedRenderResult
isPermitted() - Method in class com.docmosis.document.ExternalResourcePermissionsCheckResult
isPopulable() - Method in interface com.docmosis.template.analysis.TemplateSection: Determine if this section has items in it which may be candidates for population.
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.
isQRCode() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement
isRepeatable() - Method in interface com.docmosis.template.analysis.TemplateSection: Determine if this section is repeatable
isRepeatingSection() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement
isSkipSection() - Method in interface com.docmosis.template.analysis.TemplateSection: Determine if this section indicates a skip (and hence should be skipped).
isSubsequentFormatSave() - Method in class com.docmosis.document.CoordinatedRenderResult: Determine if this is a document from the same render as another document but just a format variant.
isSubstitution() - Method in class com.docmosis.template.analysis.fontmapping.FontMappingUseItem: True if this mapping is substituting the FontMappingUseItem.originalFont with a different font.
isTemplateReference() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement
isTemplateReferenceStatic() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement
isVariableGetField() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement
isVariableSetField() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureElement
isWord() - Method in class com.docmosis.document.converter.ConversionFormat: Determine whether this format is one of the Word variants (RTF excluded).

J

JSONDataProvider - Class in com.docmosis.template.population: A MemoryDataProvider that can load itself from JSON formatted data.
JSONDataProvider() - Constructor for class com.docmosis.template.population.JSONDataProvider
JSONDataProvider(String, StringInterceptor[]) - Constructor for class com.docmosis.template.population.JSONDataProvider: Construct a data provider from a JSON string.
JSONDummyDataTemplateStructureProcessor - Class in com.docmosis.template.analysis.structure: This class creates dummy data based on the content found in a template.
JSONDummyDataTemplateStructureProcessor() - Constructor for class com.docmosis.template.analysis.structure.JSONDummyDataTemplateStructureProcessor
JSONException - Exception in org.json.com.docmosis: The JSONException is thrown by the JSON.org classes when things are amiss.
JSONException(String) - Constructor for exception org.json.com.docmosis.JSONException: Constructs a JSONException with an explanatory message.
JSONException(Throwable) - Constructor for exception org.json.com.docmosis.JSONException
jsonRoot - Variable in class com.docmosis.template.analysis.structure.JSONDummyDataTemplateStructureProcessor

K

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

L

ListStyle - Class in com.docmosis.template.analysis.list: This class provides details of a template List style element that can be used for dynamically deriving new variants of the style
ListStyle(String, String, String) - Constructor for class com.docmosis.template.analysis.list.ListStyle
ListStyle(String, String, String, boolean) - Constructor for class com.docmosis.template.analysis.list.ListStyle
ListStyles - Class in com.docmosis.template.analysis.list: This class aggregates template List style elements
ListStyles() - Constructor for class com.docmosis.template.analysis.list.ListStyles
ListTree - Class in com.docmosis.template.analysis.list: This class provides a tree structure suitable for dealing with ODT document list elements and their relationships.
ListTree() - Constructor for class com.docmosis.template.analysis.list.ListTree
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

MAGNIFICATION - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
main(String[]) - Static method in class com.docmosis.document.converter.RemoteConverter
main(String[]) - Static method in class com.docmosis.document.converter.RemoteConverterTerminus: Deprecated.
main(String[]) - Static method in class com.docmosis.document.DocumentConverter: A public main entry point to allow conversions to be run from the command line.
main(String[]) - Static method in class com.docmosis.template.analysis.SimpleTemplateTableCell
MappingException - Exception in com.sun.star.uno: Deprecated. since UDK 3.0.2
MappingException() - Constructor for exception com.sun.star.uno.MappingException: Deprecated. Contructs an empty MappingException.
MappingException(String) - Constructor for exception com.sun.star.uno.MappingException: Deprecated. Contructs an MappingException with a detail message.
MappingException(String, Object) - Constructor for exception com.sun.star.uno.MappingException: Deprecated. Contructs an MappingException with a detail message and a context.
MAX_IMAGE_RESOLUTION - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
MemoryDataProvider - Class in com.docmosis.template.population: An efficient memory based DataProvider.
MemoryDataProvider() - Constructor for class com.docmosis.template.population.MemoryDataProvider: Basic constructor.
MemoryDataProviderFactory - Class in com.docmosis.template.population
MemoryDataProviderFactory() - Constructor for class com.docmosis.template.population.MemoryDataProviderFactory
memSize() - Method in class com.docmosis.template.analysis.ImageAnalysis.ImageDetail: Computed mem size (w*h*d) in bytes.
MessageAndSuggestions - Class in com.docmosis.template.analysis: A container for an error message and possibly suggestions to assist resolving it.
MessageAndSuggestions(String, String[]) - Constructor for class com.docmosis.template.analysis.MessageAndSuggestions
METHOD_REFLECTION_HELPER - Static variable in class com.docmosis.template.population.ReflectiveDataProvider
MutableDataProvider - Interface in com.docmosis.template.population: An interface for a data provider that is editable.
MutableDataProviderFactory - Interface in com.docmosis.template.population

N

NestingDataProvider - Class in com.docmosis.template.population
NestingDataProvider(DataProvider) - Constructor for class com.docmosis.template.population.NestingDataProvider
NestingDataProvider(DataProvider, MutableDataProviderFactory) - Constructor for class com.docmosis.template.population.NestingDataProvider
NoConvertersRunningException - Exception in com.docmosis.document.converter
NoConvertersRunningException() - Constructor for exception com.docmosis.document.converter.NoConvertersRunningException
NoConvertersRunningException(String) - Constructor for exception com.docmosis.document.converter.NoConvertersRunningException
NoConvertersRunningException(Throwable) - Constructor for exception com.docmosis.document.converter.NoConvertersRunningException
NoConvertersRunningException(String, Throwable) - Constructor for exception com.docmosis.document.converter.NoConvertersRunningException
NONE - Static variable in class com.docmosis.document.converter.ConversionInstruction.PDFImageReduceResolutionSetting
NONE - Static variable in class com.docmosis.document.ExternalResourcePermissions: No permission granted
NoSuchColumnNameException - Exception in com.docmosis.template.population: 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 exception com.docmosis.template.population.NoSuchColumnNameException: Create a new exception with a message.
NumberRenderer - Class in com.docmosis.template.population.render: A renderer for formatting numbers
NumberRenderer() - Constructor for class com.docmosis.template.population.render.NumberRenderer

O

OPEN_IN_FULL_SCREEN_MODE - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
org.json.com.docmosis - package org.json.com.docmosis

P

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.
ParseException - Exception in com.docmosis.template
ParseException() - Constructor for exception com.docmosis.template.ParseException
ParseException(String) - Constructor for exception com.docmosis.template.ParseException
ParseException(String, Throwable) - Constructor for exception com.docmosis.template.ParseException
ParseException(Throwable) - Constructor for exception com.docmosis.template.ParseException
PASSWORD - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
PDF_INITIAL_VIEW_DEFAULT - Static variable in class com.docmosis.document.converter.ConversionInstruction: default view with neither outlines or thumbnails
PDF_INITIAL_VIEW_OUTLINE - Static variable in class com.docmosis.document.converter.ConversionInstruction: initial view with outline pane visible
PDF_INITIAL_VIEW_THUMBNAIL - Static variable in class com.docmosis.document.converter.ConversionInstruction: initial view with thumbnail pane visible
PDF_RESTRICTED_CHANGES_FILLING_OF_FORM_FIELDS - Static variable in class com.docmosis.document.converter.ConversionInstruction: Pdf restricted with filling of form fields allowed
PDF_RESTRICTED_CHANGES_FILLING_OF_FORM_FIELDS_AND_COMMENTING - Static variable in class com.docmosis.document.converter.ConversionInstruction: Pdf restricted with filling of form fields and commenting allowed
PDF_RESTRICTED_CHANGES_INSERT_DELETE_ROTATE_PAGES - Static variable in class com.docmosis.document.converter.ConversionInstruction: Pdf restricted with inserting deleting and rotating pages allowed
PDF_RESTRICTED_CHANGES_NO_CHANGES_ALLOWED - Static variable in class com.docmosis.document.converter.ConversionInstruction: Pdf restricted with no changes allowed
PDF_RESTRICTED_CHANGES_PAGE_EXTRACTION_RESTRICTED - Static variable in class com.docmosis.document.converter.ConversionInstruction: Pdf restricted with inserting deleting and rotating pages allowed, filling of form fields and commenting allowed.
PDF_RESTRICTED_PRINTING_CANNOT_BE_PRINTED - Static variable in class com.docmosis.document.converter.ConversionInstruction: Restricted printing to cannot be printed
PDF_RESTRICTED_PRINTING_LOW_RESOLUTION - Static variable in class com.docmosis.document.converter.ConversionInstruction: Restricted printing to low resolution only
PDF_RESTRICTED_PRINTING_MAX_RESOLUTION - Static variable in class com.docmosis.document.converter.ConversionInstruction: Restricted printing to maximum resolution
PDF_UA_COMPLIANCE - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
PERMISSION_PASSWORD - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
permitted(ExternalResourcePermissions, ExternalResourceCollection, boolean, boolean) - Static method in class com.docmosis.document.ExternalResourcePermissions: Check whether permission is granted for all given resources.
permitted(ExternalResourceCollection, boolean, boolean) - Method in class com.docmosis.document.ExternalResourcePermissions: Determine whether the given resource urls are permitted based on this instances prefixes.
permitted(String, boolean, boolean) - Method in class com.docmosis.document.ExternalResourcePermissions: Determine whether the given url is permitted based on this instances prefixes.
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.
PopulationException - Exception in com.docmosis.template.population
PopulationException() - Constructor for exception com.docmosis.template.population.PopulationException
PopulationException(String) - Constructor for exception com.docmosis.template.population.PopulationException
PopulationException(Throwable) - Constructor for exception com.docmosis.template.population.PopulationException
PopulationException(String, Throwable) - Constructor for exception com.docmosis.template.population.PopulationException
PRINTING - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
process(TemplateStructureProcessor) - Method in class com.docmosis.template.analysis.structure.TemplateStructureExtractor: Process the structure using the given processor.
process(TemplateStructureProcessor, TemplateIdentifier) - Static method in class com.docmosis.template.analysis.structure.TemplateStructureExtractor: This convenience method will get the template from the default TemplateStore and extract the structure before passing it to the given processor to process.
process(String, String, MutableDataProvider) - Method in class com.docmosis.template.population.data.Base64ImageStringInterceptor
process(String, String, MutableDataProvider) - Method in interface com.docmosis.template.population.StringInterceptor: Process the given key and value to make optional adjustments to the given DataProvider.
process(File) - Method in class com.docmosis.template.store.DropStoreHelper: Drop a whole directory of templates into the store processing sub-directories recursively.
process(File, TemplateContext) - Method in class com.docmosis.template.store.DropStoreHelper: Drop a whole directory of templates into the store recursively 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.
processDirectory(File, TemplateContext, boolean, boolean) - Method in class com.docmosis.template.store.DropStoreHelper: Drop a whole directory of templates into the store, optionally into a specified context, processing sub-directories and error handling.
ProcessingException - Exception in com.docmosis.document: This general exception indicates something went wrong with the procesing of the documents or templates.
ProcessingException() - Constructor for exception com.docmosis.document.ProcessingException
ProcessingException(String) - Constructor for exception com.docmosis.document.ProcessingException
ProcessingException(Throwable) - Constructor for exception com.docmosis.document.ProcessingException
ProcessingException(String, Throwable) - Constructor for exception com.docmosis.document.ProcessingException
processJarOrZipFile(File) - Method in class com.docmosis.template.store.DropStoreHelper: Process the contents of a Jar or Zip file as it if was a directory.
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) - Method in class com.docmosis.template.store.DropStoreHelper: Process templates from the specified URL.
processResource(URL, TemplateContext, boolean) - Method in class com.docmosis.template.store.DropStoreHelper: Process templates from the specified URL.
producesZippedDocument() - Method in class com.docmosis.document.converter.ConversionInstruction: Determines if this instruction produces a zipped result.
PROP_EXTERNAL_RESOURCES_COMPARE_CASE_INSENSITIVE - Static variable in class com.docmosis.template.store.StoreHelper
PROP_EXTERNAL_RESOURCES_COMPARE_DECODE_URLS - Static variable in class com.docmosis.template.store.StoreHelper
PROP_EXTERNAL_RESOURCES_DEFAULT_PERMISSION - Static variable in class com.docmosis.template.store.StoreHelper
PROP_EXTERNAL_RESOURCES_EXTRACT_ENABLED - Static variable in class com.docmosis.template.store.StoreHelper
PROP_NAME_GENERATED_FILES_PRESERVE - Static variable in class com.docmosis.document.DocumentProcessor
PROPERTY_FIELD_ALLOW_PADDED - Static variable in class com.docmosis.template.store.TemplateStoreFactory
PROPERTY_PLAINTEXT_FIELD_PREFIX - Static variable in class com.docmosis.template.store.TemplateStoreFactory
PROPERTY_PLAINTEXT_FIELD_SUFFIX - Static variable in class com.docmosis.template.store.TemplateStoreFactory
PROPERTY_STORE_LOCATION - Static variable in class com.docmosis.template.store.TemplateStoreFactory

Q

QUALITY - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties

R

RangeIteratorException - Exception in com.docmosis.template.analysis
RangeIteratorException(String) - Constructor for exception com.docmosis.template.analysis.RangeIteratorException
REDUCE_IMAGE_RESOLUTION - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
reflectedDelegate - Variable in exception com.docmosis.template.population.DataProvisionNotFoundException
reflectedDelegate - Variable in class com.docmosis.template.population.ReflectiveDataProvider
reflectedDelegateClass - Variable in exception com.docmosis.template.population.DataProvisionNotFoundException
reflectedDelegateClass - Variable in class com.docmosis.template.population.ReflectiveDataProvider
ReflectiveCollectionDataProvider - Class in com.docmosis.template.population
ReflectiveCollectionDataProvider(Object, boolean, ReflectiveDataProvider.DataFormatManager) - Constructor for class com.docmosis.template.population.ReflectiveCollectionDataProvider
ReflectiveDataProvider - Class in com.docmosis.template.population: 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 in com.docmosis.template.population: 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
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.
RemoteConverter - Class in com.docmosis.document.converter: This class launches a stand alone remote converter.
RemoteConverter(int) - Constructor for class com.docmosis.document.converter.RemoteConverter: Construct a remote converter listening on the given port, using defaults for other settings.
RemoteConverter(String, File, int, SSLSocketSettings) - Constructor for class com.docmosis.document.converter.RemoteConverter: Construct a new RemoteConverter using the given ConverterClass, executable and port.
RemoteConverterTerminus - Class in com.docmosis.document.converter: Deprecated. superseded by RemoteConverter
RemoteConverterTerminus(String, File, int, SSLSocketSettings) - Constructor for class com.docmosis.document.converter.RemoteConverterTerminus: Deprecated.
removeFormatter(Class) - Method in class com.docmosis.template.population.ReflectiveDataProvider.DataFormatManager
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.
render(FieldDetails, RenderedField) - Method in class com.docmosis.template.population.render.NumberRenderer
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(TemplateIdentifier, DataProvider, ConversionInstruction, OutputStream, ExternalResourcePermissions) - 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(RenderRequest) - Static method in class com.docmosis.document.DocumentProcessor: Execute a render using the given render request.
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, File, DataProvider, ExternalResourcePermissions) - Static method in class com.docmosis.document.DocumentProcessor: Render the given template to the given output file with the given data.
renderDoc(File, File, DataProvider, boolean) - Static method in class com.docmosis.document.DocumentProcessor: Render the given template to the given output file with the given data.
renderDoc(File, File, DataProvider, boolean, ExternalResourcePermissions) - 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, ExternalResourcePermissions) - Static method in class com.docmosis.document.DocumentProcessor: Render the given template to the given output stream with the given data.
renderDoc(File, OutputStream, ConversionFormat, DataProvider, boolean, ExternalResourcePermissions) - Static method in class com.docmosis.document.DocumentProcessor: Render the given template to the given output stream with the given data.
RenderedField - Class in com.docmosis.template.population.render: 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
RendererRegistry - Class in com.docmosis.template.population.render: A registry of FieldRenderers that can be applied to template fields
RendererRegistry() - Constructor for class com.docmosis.template.population.render.RendererRegistry
RendererRegistry(RendererRegistry) - Constructor for class com.docmosis.template.population.render.RendererRegistry: Create a stand alone copy of this registry.
RenderRequest - Class in com.docmosis.document: This class provides a way way of building the set of parameters for a render request, including less commonly used parameters.
RenderRequest() - Constructor for class com.docmosis.document.RenderRequest
repeatBegin(TemplateStructureElement, int) - Method in class com.docmosis.template.analysis.structure.JSONDummyDataTemplateStructureProcessor
repeatBegin(TemplateStructureElement, int) - Method in class com.docmosis.template.analysis.structure.SimpleJSONTemplateStructureProcessor
repeatBegin(TemplateStructureElement, int) - Method in interface com.docmosis.template.analysis.structure.TemplateStructureProcessor: Process the start of a repeating section.
repeatEnd(TemplateStructureElement, int) - Method in class com.docmosis.template.analysis.structure.JSONDummyDataTemplateStructureProcessor
repeatEnd(TemplateStructureElement, int) - Method in class com.docmosis.template.analysis.structure.SimpleJSONTemplateStructureProcessor
repeatEnd(TemplateStructureElement, int) - Method in interface com.docmosis.template.analysis.structure.TemplateStructureProcessor: Process the end of a repeating section
requiresArtificialParagraph() - Method in class com.docmosis.template.analysis.TextWritableSafeAreas.ParagraphMapItem
RESTRICT_PERMISSIONS - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
run() - Method in class com.docmosis.document.converter.RemoteConverter: Run this Converter.

S

SELECT_PDF_VERSION - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
setAllColumnsLeftConditional(boolean) - Method in class com.docmosis.template.analysis.SimpleTemplateTableCell
setAllColumnsRightConditional(boolean) - Method in class com.docmosis.template.analysis.SimpleTemplateTableCell
setAlternatingBackgroundColours(String, String) - Method in class com.docmosis.template.analysis.TableCellStyle: Plug in alternating bg colour attributes.
setAutoDecodeBase64Images(boolean) - Method in class com.docmosis.template.population.DataProviderBuilder: Enable/Disable the auto decoding of base64 embedded images in data values.
setBold(boolean) - Method in class com.docmosis.template.population.render.RenderedField: Specify whether to add the bold font attribute.
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
setBorderStyles(String, String) - Method in class com.docmosis.template.analysis.TableCellStyle: Set the border styles for the first top and last bottom border.
setCanRetry(boolean) - Method in exception com.docmosis.document.ProcessingException: Set the retry flag.
setCellBackgroundColour(String) - Method in class com.docmosis.template.population.render.RenderedField: Set the background colour of the table cell containing the field (if applicable).
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.
setColumnsSpanned(int) - Method in class com.docmosis.template.analysis.SimpleTemplateTableCell
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.
setConversionInstruction(ConversionInstruction) - Method in class com.docmosis.document.RenderRequest: Set the conversion instruction to use for this request.
setConversionSettings(ConversionSettings) - Method in class com.docmosis.document.RenderRequest: Specify conversion settings to use.
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.
setConvertOnly(boolean) - Method in class com.docmosis.document.converter.ConversionInstruction: Specify this instruction is flagged as "convert only" meaning extra processing (such as updating TOC and counting pages) is not done.
setCoordinatedResults(List<CoordinatedRenderResult>) - Method in class com.docmosis.document.CoordinatedRenderResults
setCoordinatedResults(CoordinatedRenderResults) - Method in class com.docmosis.document.DocumentRenderResult
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.
setDataProvider(DataProvider) - Method in class com.docmosis.document.RenderRequest: Set the data to use for the render
setDataReferenceCollector(DataReferenceCollector) - Method in class com.docmosis.template.analysis.structure.SimpleJSONTemplateStructureProcessor
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.
setDefaultRendererByClass(Class, FieldRenderer) - Static method in class com.docmosis.template.population.render.RendererRegistry: Register a default renderer for Objects of the given type.
setDefaultRendererByClassAndName(Class, String, FieldRenderer) - Static method in class com.docmosis.template.population.render.RendererRegistry
setDefaultRendererByName(String, FieldRenderer) - Static method in class com.docmosis.template.population.render.RendererRegistry
setExternalResourcePermissions(ExternalResourcePermissions) - Method in class com.docmosis.document.RenderRequest: Set the external resource permissions for this request.
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
setForceInternalConverterForDocXTemplates(boolean) - Method in class com.docmosis.document.converter.ExtendedConversionInstruction
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
setImages(ImageAnalysis.ImageDetail[]) - Method in class com.docmosis.template.analysis.ImageAnalysis
setImageScalingDefault(ImageScalingDefault) - Method in class com.docmosis.document.RenderRequest: Set the default image scaling method (eg fit or stretch) to use when inserting images into the template.
setImageSupplier(ImageSupplier) - Method in class com.docmosis.document.RenderRequest: Set the image supplier to use for sourcing images for population.
setIncludeImages(boolean) - Method in class com.docmosis.template.analysis.structure.JSONDummyDataTemplateStructureProcessor
setInjectedAttributeString(String) - Method in class com.docmosis.template.population.XMLDataProvider: Marks the given key as an "injected" or "pushed up" attribute meaning that it was artificially injected into this DP when processing the XML structure.
setItalic(boolean) - Method in class com.docmosis.template.population.render.RenderedField: Specify whether to add the italic font attribute.
setKeepRowTogetherStyleSet(boolean) - Method in class com.docmosis.template.analysis.SimpleTemplateTableRow
setLeftBorderStyle(String) - Method in class com.docmosis.template.analysis.SimpleTemplateTableRow
setNewFileName(String) - Method in class com.docmosis.document.CoordinatedRenderResult
setNewFileRequested(boolean) - Method in class com.docmosis.document.CoordinatedRenderResult
setnRepeats(int) - Method in class com.docmosis.template.analysis.structure.JSONDummyDataTemplateStructureProcessor
setOutputFile(File) - Method in class com.docmosis.document.RenderRequest: Set the file to write the result to.
setOutputFileName(String) - Method in class com.docmosis.document.converter.ConversionInstruction: Specify the filename for output.
setOutputStream(OutputStream) - Method in class com.docmosis.document.RenderRequest: Specify where to stream the result.
setPadToEvenPageRequested(boolean) - Method in class com.docmosis.document.CoordinatedRenderResult
setPadToOddPageRequested(boolean) - Method in class com.docmosis.document.CoordinatedRenderResult
setPdfArchiveMode(boolean) - Method in class com.docmosis.document.converter.ConversionInstruction: Deprecated. use #setPdfVersion() instead
setPdfCreateForm(boolean) - Method in class com.docmosis.document.converter.ConversionInstruction: Specify whether the PDF should contain interactable form fields or not.
setPdfDisplayTitle(boolean) - Method in class com.docmosis.document.converter.ConversionInstruction: Set whether to display the document title (if available) in the PDF window title bar.
setPdfEmbedStandardFonts(boolean) - Method in class com.docmosis.document.converter.ConversionInstruction: Specifies whether to embed the 14 standard PDF fonts or not.
setPdfHideViewerMenubar(boolean) - Method in class com.docmosis.document.converter.ConversionInstruction: Specifies whether to hide the PDF viewer menubar when the document is active.
setPdfHideViewerToolbar(boolean) - Method in class com.docmosis.document.converter.ConversionInstruction: Specifies whether to hide the PDF viewer toolbar when the document is active.
setPdfHideViewerWindowControls(boolean) - Method in class com.docmosis.document.converter.ConversionInstruction: Specifies whether to hide the PDF viewer controls when the document is active.
setPdfImageCompressionQuality(int) - Method in class com.docmosis.document.converter.ConversionInstruction: Specifies quality of images in PDF output.
setPdfImageCompressionQualityFromString(String) - Method in class com.docmosis.document.converter.ConversionInstruction: Set the pdf output image compression quality from a string value.
setPdfImageReduceResolution(ConversionInstruction.PDFImageReduceResolutionSetting) - Method in class com.docmosis.document.converter.ConversionInstruction: Set the image DPI for PDF output.
setPdfImageReduceResolutionFromString(String) - Method in class com.docmosis.document.converter.ConversionInstruction: Set the pdf output image resolution to the given DPI setting Note: adjusting this setting may greatly increase the size of the output PDF, depending on the images used.
setPdfInitialView(int) - Method in class com.docmosis.document.converter.ConversionInstruction: Specifies how the PDF document should be displayed when opened.
setPdfLosslessConversion(boolean) - Method in class com.docmosis.document.converter.ConversionInstruction: Specifies if graphics are exported to PDF using a lossless compression eg.
setPdfMagnification(int, int) - Method in class com.docmosis.document.converter.ConversionInstruction: Set the magnification and zoom.
setPdfOpenInFullScreen(boolean) - Method in class com.docmosis.document.converter.ConversionInstruction: Set whether to open the PDF in fullscreen mode or not.
setPdfPasswordProtect(String) - Method in class com.docmosis.document.converter.ConversionInstruction: Set a password to read-protect a PDF document.
setPdfRestrictAllowAccessibilty(boolean) - Method in class com.docmosis.document.converter.ConversionInstruction: Set whether the document content can be extracted to be used in accessibility applications for a PDF document.
setPdfRestrictCopy(boolean) - Method in class com.docmosis.document.converter.ConversionInstruction: Set whether the pages and the document content can be extracted to be used in other documents (copy and paste) for a PDF document.
setPdfRestrictEditing(int) - Method in class com.docmosis.document.converter.ConversionInstruction: Specifies what changes are allowed for a PDF document.
setPdfRestrictPassword(String) - Method in class com.docmosis.document.converter.ConversionInstruction: Set a password to restrict permissions for a PDF document.
setPdfRestrictPrinting(int) - Method in class com.docmosis.document.converter.ConversionInstruction: Specifies what printing is allowed for a PDF document.
setPdfSkipEmptyPages(boolean) - Method in class com.docmosis.document.converter.ConversionInstruction: Specify whether the PDF should skip empty pages.
setPdfTagged(boolean) - Method in class com.docmosis.document.converter.ConversionInstruction: Specify whether the PDF should be tagged.
setPdfUniversalAccessibility(boolean) - Method in class com.docmosis.document.converter.ConversionInstruction: Set whether to use PDF universal accessibility (PDF/UA) mode or not.
setPdfVersion(ConversionInstruction.PdfVersion) - Method in class com.docmosis.document.converter.ConversionInstruction: Set the PDF version to use.
setPdfWatermark(String) - Method in class com.docmosis.document.converter.ConversionInstruction: Set whether to use a watermark or not.
setPdfWatermarkColor(String) - Method in class com.docmosis.document.converter.ConversionInstruction: Specifies the color of the pdf watermark.
setPdfWatermarkFontName(String) - Method in class com.docmosis.document.converter.ConversionInstruction: Specifies the font name of the pdf watermark.
setPdfWatermarkFontSize(int) - Method in class com.docmosis.document.converter.ConversionInstruction: Specifies the font size of the pdf watermark.
setPdfWatermarkRotation(int) - Method in class com.docmosis.document.converter.ConversionInstruction: Specifies the rotation angle of the pdf watermark.
setPopulationErrorsFatal(Boolean) - Method in class com.docmosis.document.RenderRequest: Specify whether population errors should be fatal.
setProcessStylesInText(Boolean) - Method in class com.docmosis.document.RenderRequest: Specify whether text data should be parsed for HTML-like data.
setRemoveTemplateAfterUse(boolean) - Method in class com.docmosis.document.RenderRequest: Specify whether or not the template should be removed from the TemplateStore (the local cache) after being used for rendering.
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.
setRendererByClass(Class, FieldRenderer) - Method in class com.docmosis.template.population.render.RendererRegistry: Set a renderer in this instance for the given class type.
setRendererByClassAndName(Class, String, FieldRenderer) - Method in class com.docmosis.template.population.render.RendererRegistry: Set a renderer in this instance against the given name and Class at the same time.
setRendererByName(String, FieldRenderer) - Method in class com.docmosis.template.population.render.RendererRegistry: Set a renderer in this instance against the given name.
setResources(List<String>) - Method in class com.docmosis.document.ExternalResourceCollection
setRightBorderStyle(String) - Method in class com.docmosis.template.analysis.SimpleTemplateTableRow
setRowsSpanned(int) - Method in class com.docmosis.template.analysis.SimpleTemplateTableCell
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
setStyle(TableCellStyle) - Method in class com.docmosis.template.analysis.SimpleTemplateTableCell
setStyleNameEndIdx(long) - Method in class com.docmosis.template.analysis.SimpleTemplateTableCell
setStyleNameStartIdx(long) - Method in class com.docmosis.template.analysis.SimpleTemplateTableCell
setSubsequentFormatSave(boolean) - Method in class com.docmosis.document.CoordinatedRenderResult
setTemplateFile(File) - Method in class com.docmosis.document.RenderRequest: Specify the template to use by a direct reference to the source template file.
setTemplateIdentifier(TemplateIdentifier) - Method in class com.docmosis.document.RenderRequest: Set the template to use.
setTemplateStore(TemplateStore) - Method in class com.docmosis.document.RenderRequest: Set the template store to use.
setTemplateStream(InputStream, String, boolean) - Method in class com.docmosis.document.RenderRequest: Specify that the template is to be obtained by reading the given InputStream.
setTemplateVariable(String, Object) - Method in class com.docmosis.template.population.render.FieldDetails: Set a template variable at this point of processing in the template.
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: Specify whether to add the underline font attribute.
setValue(String) - Method in class com.docmosis.template.population.render.RenderedField: Set the text to display for the field.
setWordPasswordProtect(String) - Method in class com.docmosis.document.converter.ConversionInstruction: Set an encrypted password to protect a Word document.
setWordTextHighlight(Boolean) - Method in class com.docmosis.document.converter.ConversionInstruction: Set word-related output (docx, doc, rft) to use "text highlight" (true) rather than "text shading" (false) for highlighted text.
shutdown() - Method in class com.docmosis.document.converter.RemoteConverter
shutdown() - Static method in class com.docmosis.template.population.render.RendererRegistry: Release all default renderers held
SimpleJSONTemplateStructureProcessor - Class in com.docmosis.template.analysis.structure: This class can process a template structure and then output the template information in an JSON format.
SimpleJSONTemplateStructureProcessor() - Constructor for class com.docmosis.template.analysis.structure.SimpleJSONTemplateStructureProcessor
SimpleJSONTemplateStructureProcessor(String) - Constructor for class com.docmosis.template.analysis.structure.SimpleJSONTemplateStructureProcessor: Create a new processor which creates a JSON object with one element using the mainKeyName name.
SimpleSQLDataProviderPopulator - Class in com.docmosis.template.population: A class responsible for populating a data provider given an SQL Result Set.
SimpleTemplateTableCell - Class in com.docmosis.template.analysis: A section representing a table row
SimpleTemplateTableCell() - Constructor for class com.docmosis.template.analysis.SimpleTemplateTableCell
SimpleTemplateTableRow - Class in com.docmosis.template.analysis: A section representing a table row
SimpleTemplateTableRow() - Constructor for class com.docmosis.template.analysis.SimpleTemplateTableRow
SimpleXMLTemplateStructureProcessor - Class in com.docmosis.template.analysis.structure: This class can process a template structure and then output the template information in an XML format.
SimpleXMLTemplateStructureProcessor() - Constructor for class com.docmosis.template.analysis.structure.SimpleXMLTemplateStructureProcessor
size() - Method in class com.docmosis.document.CoordinatedRenderResults
size() - Method in class com.docmosis.template.analysis.ImageAnalysis.ImageDetail: The size of the image as a file or stream in bytes.
SKIP_EMPTY_PAGES - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
skipPreAndPostAmble() - Method in interface com.docmosis.template.analysis.TemplateSection: Determine if this section has pre and post amble sections that should be skipped during population.
SortException - Exception in com.docmosis.template.analysis.sorting
SortException(String) - Constructor for exception com.docmosis.template.analysis.sorting.SortException
spansMultipleRowsAndInNonBreakingRow() - Method in class com.docmosis.template.analysis.SimpleTemplateTableCell: Determine if this cell spans multiple rows and is within a table row that is set to non-breaking.
SQLDataItem - Class in com.docmosis.template.population: This class is a wrapper keeping a value retrieved from a database associated with it's data type.
SQLDataItem(Class, Object) - Constructor for class com.docmosis.template.population.SQLDataItem
SQLDataProvider - Class in com.docmosis.template.population: 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 in com.docmosis.template.population
SQLDataProviderFactory() - Constructor for class com.docmosis.template.population.SQLDataProviderFactory
start() - Method in class com.docmosis.template.analysis.structure.JSONDummyDataTemplateStructureProcessor
start() - Method in class com.docmosis.template.analysis.structure.SimpleJSONTemplateStructureProcessor
start() - Method in interface com.docmosis.template.analysis.structure.TemplateStructureProcessor: Perform processing for the beginning of the template structure.
StoreHelper - Class in com.docmosis.template.store: This class provides methods to register templates into the template store.
StoreHelper() - Constructor for class com.docmosis.template.store.StoreHelper
storeTemplate(String, File, TemplateStore) - Static method in class com.docmosis.template.store.StoreHelper: Store a template in the given template store.
storeTemplate(String, File, TemplateStore, ExternalResourcePermissions) - Static method in class com.docmosis.template.store.StoreHelper: As above, but with explicit permissions regarding external links.
storeTemplate(String, File, boolean, TemplateStore, ExternalResourcePermissions) - Static method in class com.docmosis.template.store.StoreHelper: As above, but with explicit permissions regarding external links.
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, File, TemplateStore, ExternalResourcePermissions) - Static method in class com.docmosis.template.store.StoreHelper: As above, but with explicit permissions regarding external links.
storeTemplate(TemplateIdentifier, InputStream, Long, boolean, boolean, TemplateStore, ExternalResourcePermissions) - 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, File, boolean, boolean, TemplateStore, ExternalResourcePermissions) - 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, File, boolean, boolean, TemplateStore, ExternalResourcePermissions, ConversionSettings) - 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, Long, InputStream, TemplateAnalysis, InputStream, boolean, boolean, String, String, boolean, PropertiesProvider) - Method in interface com.docmosis.template.store.TemplateStore: Store the given InputStream as a template using the given templateId.
storeTemplate(TemplateIdentifier, InputStream, Long, InputStream, TemplateAnalysis, InputStream, boolean, boolean, String, String, boolean, PropertiesProvider) - Method in class com.docmosis.template.store.TemplateStoreFactory.PresetTemplateStore
STRETCH - Static variable in class com.docmosis.document.ImageScalingDefault: Use this constant to specify default images should stretch to fit both x and y
StringInterceptor - Interface in com.docmosis.template.population: StringInterceptors can make custom judgements about the the data that is about to be plugged into a DataProvider.
StringInterceptorException - Exception in com.docmosis.template.population
StringInterceptorException(String, Throwable, boolean) - Constructor for exception com.docmosis.template.population.StringInterceptorException
StringInterceptorException(String, boolean) - Constructor for exception com.docmosis.template.population.StringInterceptorException
StringInterceptorException(Throwable, boolean) - Constructor for exception com.docmosis.template.population.StringInterceptorException
stylesVary() - Method in class com.docmosis.template.analysis.TableCellStyle.RepeatingRowTopAndBottomBorderStyles: Determine if the styles vary from row to row or if they are all the same.
SYSTEM_SETTINGS - Static variable in class com.docmosis.document.ImageScalingDefault: Use this constant to specify default images should just do system default (docmosis.analyzer.image.scaling.default property)
SystemManager - Class in com.docmosis: Initialise the document processing system.
SystemManager() - Constructor for class com.docmosis.SystemManager

T

TableCellStyle - Class in com.docmosis.template.analysis: Style information for a table cell.
TableCellStyle(List) - Constructor for class com.docmosis.template.analysis.TableCellStyle
TableCellStyle(TableCellStyle) - Constructor for class com.docmosis.template.analysis.TableCellStyle: Create a clone of this TableCellStyle.
TableCellStyle.RepeatingRowTopAndBottomBorderStyles - Class in com.docmosis.template.analysis: This class manages the transitions for border styles for repeating rows.
TableCellStyle.RepeatingRowTopAndBottomBorderStyles(String, String, String, String) - Constructor for class com.docmosis.template.analysis.TableCellStyle.RepeatingRowTopAndBottomBorderStyles
TAGGED_PDF - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
Template - Interface in com.docmosis.template: This interface defines the minimal facilities a template must provide.
TemplateAlreadyExistsException - Exception in com.docmosis.template: This exception is used to identify a problem parsing a template.
TemplateAlreadyExistsException() - Constructor for exception com.docmosis.template.TemplateAlreadyExistsException
TemplateAlreadyExistsException(String, Throwable) - Constructor for exception com.docmosis.template.TemplateAlreadyExistsException
TemplateAlreadyExistsException(String) - Constructor for exception com.docmosis.template.TemplateAlreadyExistsException
TemplateAlreadyExistsException(Throwable) - Constructor for exception com.docmosis.template.TemplateAlreadyExistsException
TemplateAnalysis - Interface in com.docmosis.template.analysis: A template analysis provides details about a (populable) template that may help in processing the template (performance hints).
TemplateContext - Class in com.docmosis.template.store: 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 in com.docmosis.template: 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
templateExists(TemplateIdentifier, TemplateStore) - Static method in class com.docmosis.template.store.StoreHelper: Determines whether the given template exists in the store.
TemplateExpression - Class in com.docmosis.template.analysis.structure: Break down of elements in a Template Expression to assist structure processing
TemplateExpression(String, AbstractStructureElement.FieldSectionElement[]) - Constructor for class com.docmosis.template.analysis.structure.TemplateExpression
TemplateField - Interface in com.docmosis.template.analysis: A template field is a section of a template that is a substitutable field.
TemplateIdentifier - Class in com.docmosis.template.store: 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, String) - Constructor for class com.docmosis.template.store.TemplateIdentifier: Construct a new template identifier with the given name and context.
TemplateIdentifier(String, TemplateContext) - Constructor for class com.docmosis.template.store.TemplateIdentifier: Construct a new identifier with the given name and context.
TemplateNotFoundException - Exception in com.docmosis.template
TemplateNotFoundException() - Constructor for exception com.docmosis.template.TemplateNotFoundException
TemplateNotFoundException(String) - Constructor for exception com.docmosis.template.TemplateNotFoundException
TemplateNotFoundException(Throwable) - Constructor for exception com.docmosis.template.TemplateNotFoundException
TemplateNotFoundException(String, Throwable) - Constructor for exception com.docmosis.template.TemplateNotFoundException
TemplateParseException - Exception in com.docmosis.template: This exception is used to identify a problem parsing a template.
TemplateParseException() - Constructor for exception com.docmosis.template.TemplateParseException
TemplateParseException(String, Throwable) - Constructor for exception com.docmosis.template.TemplateParseException
TemplateParseException(String) - Constructor for exception com.docmosis.template.TemplateParseException
TemplateParseException(String, boolean) - Constructor for exception com.docmosis.template.TemplateParseException
TemplateParseException(String, long) - Constructor for exception com.docmosis.template.TemplateParseException
TemplateParseException(Throwable) - Constructor for exception com.docmosis.template.TemplateParseException
TemplateParseException(String, Throwable, String[]) - Constructor for exception com.docmosis.template.TemplateParseException
TemplateParseException(String, Throwable, String[], long) - Constructor for exception com.docmosis.template.TemplateParseException
TemplateParseException(String, String[]) - Constructor for exception com.docmosis.template.TemplateParseException
TemplateParseException(String, String[], long) - Constructor for exception com.docmosis.template.TemplateParseException
TemplateParseException(String, String[], long, boolean) - Constructor for exception com.docmosis.template.TemplateParseException
TemplateParseException(Throwable, String[]) - Constructor for exception com.docmosis.template.TemplateParseException
TemplateParseException(Throwable, String[], long) - Constructor for exception com.docmosis.template.TemplateParseException
templateReference(TemplateStructureElement) - Method in class com.docmosis.template.analysis.structure.JSONDummyDataTemplateStructureProcessor
templateReference(TemplateStructureElement) - Method in class com.docmosis.template.analysis.structure.SimpleJSONTemplateStructureProcessor
templateReference(TemplateStructureElement) - Method in interface com.docmosis.template.analysis.structure.TemplateStructureProcessor: Process a reference to another template
TemplateSection - Interface in com.docmosis.template.analysis: This interface defines a section of a template.
TemplateStore - Interface in com.docmosis.template.store: This interface provides access to systems for storage and retrieval of templates.
TemplateStoreException - Exception in com.docmosis.template
TemplateStoreException() - Constructor for exception com.docmosis.template.TemplateStoreException
TemplateStoreException(String) - Constructor for exception com.docmosis.template.TemplateStoreException
TemplateStoreException(Throwable) - Constructor for exception com.docmosis.template.TemplateStoreException
TemplateStoreException(String, Throwable) - Constructor for exception com.docmosis.template.TemplateStoreException
TemplateStoreException(String, Throwable, boolean) - Constructor for exception com.docmosis.template.TemplateStoreException
TemplateStoreFactory - Class in com.docmosis.template.store: This factory provides TemplateStore instances.
TemplateStoreFactory() - Constructor for class com.docmosis.template.store.TemplateStoreFactory
TemplateStoreFactory.PresetTemplateStore - Class in com.docmosis.template.store: This class facades a real TemplateStore providing values for typical settings that one might use across lots of store requests.
TemplateStructureElement - Interface in com.docmosis.template.analysis.structure: This class provides a simple interpretation of an element of a template that has been loaded into Docmosis.
TemplateStructureExtractor - Class in com.docmosis.template.analysis.structure: This class provides a simple interpretation of the structure of a template from the given analysis.
TemplateStructureExtractor(TemplateAnalysis) - Constructor for class com.docmosis.template.analysis.structure.TemplateStructureExtractor
TemplateStructureProcessor - Interface in com.docmosis.template.analysis.structure: This interface defines a processor that can be used by the TemplateStructureExtractor to analyse a template.
TemplateValidationResult - Class in com.docmosis.template: A validation result for a template.
TemplateValidationResult(MessageAndSuggestions[]) - Constructor for class com.docmosis.template.TemplateValidationResult
TextWritableSafeAreas - Class in com.docmosis.template.analysis: This class is used to provide information as to locations in a document where information can be injected safely.
TextWritableSafeAreas() - Constructor for class com.docmosis.template.analysis.TextWritableSafeAreas
TextWritableSafeAreas.ParagraphMapItem - Class in com.docmosis.template.analysis
TextWritableSafeAreas.ParagraphMapItem(long, long, boolean, boolean, boolean, boolean) - Constructor for class com.docmosis.template.analysis.TextWritableSafeAreas.ParagraphMapItem
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
TIMEOUT_ON_CRASH_SUFFIX_MESSAGE - Static variable in exception com.docmosis.document.converter.ConversionException
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, boolean) - 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
toDebugString(int, boolean) - Method in class com.docmosis.template.population.SQLDataProvider
toJSONString() - Method in class com.docmosis.template.population.JSONDataProvider: Convert this Data Provider into a JSON string.
toJSONString(MemoryDataProvider) - Static method in class com.docmosis.template.population.JSONDataProvider: Convert the given Data Provider into a JSON string.
toString() - Method in class com.docmosis.document.converter.ConversionFormat
toString() - Method in class com.docmosis.document.converter.ConversionInstruction.PDFImageReduceResolutionSetting
toString() - Method in class com.docmosis.template.analysis.fontmapping.FontInfo
toString(boolean) - Method in class com.docmosis.template.analysis.fontmapping.FontInfo
toString() - Method in class com.docmosis.template.analysis.fontmapping.FontMappingUseItem
toString() - Method in class com.docmosis.template.analysis.ImageAnalysis.ImageDetail
toString() - Method in class com.docmosis.template.analysis.list.ListStyle
toString() - Method in class com.docmosis.template.analysis.MessageAndSuggestions
toString() - Method in class com.docmosis.template.analysis.structure.JSONDummyDataTemplateStructureProcessor
toString() - Method in class com.docmosis.template.analysis.structure.SimpleJSONTemplateStructureProcessor
toString() - Method in class com.docmosis.template.analysis.structure.SimpleXMLTemplateStructureProcessor
toString() - Method in class com.docmosis.template.analysis.TextWritableSafeAreas.ParagraphMapItem
toString() - Method in class com.docmosis.template.analysis.TextWritableSafeAreas
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
toString() - Method in class com.docmosis.template.TemplateDetails
toString() - Method in exception com.docmosis.template.TemplateParseException
toStringPretty() - Method in class com.docmosis.template.population.CompoundDataProvider
toStringPretty() - Method in interface com.docmosis.template.population.DataProvider: Attempt to return a pretty String representation of the DataProvider
toStringPretty() - Method in class com.docmosis.template.population.DebugDataProvider
toStringPretty() - Method in class com.docmosis.template.population.JSONDataProvider: Convert this Data Provider into a Pretty JSON string.
toStringPretty() - Method in class com.docmosis.template.population.KeyedReflectiveDataProvider
toStringPretty() - Method in class com.docmosis.template.population.MemoryDataProvider
toStringPretty() - Method in class com.docmosis.template.population.NestingDataProvider
toStringPretty() - Method in class com.docmosis.template.population.ReflectiveCollectionDataProvider
toStringPretty() - Method in class com.docmosis.template.population.ReflectiveDataProvider: Attempt to call the toString method on the delegate.
toStringPretty() - Method in class com.docmosis.template.population.SQLDataProvider
toStringPretty() - Method in class com.docmosis.template.population.XMLDataProvider
toXML() - Method in class com.docmosis.template.population.XMLDataProvider: Convert this Data Provider into XML.
toXML(MemoryDataProvider) - Static method in class com.docmosis.template.population.XMLDataProvider: Convert the given Data Provider into XML.

U

USE_LOSSLESS_COMPRESSION - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties

V

validateTemplate(InputStream, ExternalResourcePermissions) - Static method in class com.docmosis.template.store.DropStoreHelper: Process the given stream as a template and return a TemplateValidationResult.
validateTemplate(InputStream) - Static method in class com.docmosis.template.store.StoreHelper: Process the given stream as a template and return a TemplateValidationResult.
validateTemplate(InputStream, ExternalResourcePermissions) - Static method in class com.docmosis.template.store.StoreHelper: As above, but with the specified permissions.
valueOf(String) - Static method in enum com.docmosis.document.converter.ConversionInstruction.PdfVersion: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in class com.docmosis.document.ImageScalingDefault: Find the ImageScalingDefault matching the given value
values() - Static method in enum com.docmosis.document.converter.ConversionInstruction.PdfVersion: Returns an array containing the constants of this enum type, in the order they are declared.

W

WATERMARK - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
WATERMARK_COLOR - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
WATERMARK_FONT_HEIGHT - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
WATERMARK_FONT_NAME - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
WATERMARK_ROTATE_ANGLE - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties
whitelist(String[]) - Static method in class com.docmosis.document.ExternalResourcePermissions
WORD_TEXT_HIGHLIGHTING - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties

X

XMLDataProvider - Class in com.docmosis.template.population: A data provider that can be converted to or from XML.
XMLDataProvider() - Constructor for class com.docmosis.template.population.XMLDataProvider: Create a new empty XML Data Provider.
XMLDataProvider(Document, XMLNodeFilter, boolean, StringInterceptor[]) - Constructor for class com.docmosis.template.population.XMLDataProvider: Create a new XML Data Provider with data based on the given Document.
XMLNodeFilter - Interface in com.docmosis.template.population: An interface that allows the filtering of XML nodes.

Z

ZOOM - Static variable in class com.docmosis.document.converter.ConversionInstruction.OfficeEngineProperties

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

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Docmosis API 4.9.0

PREV NEXT

FRAMES NO FRAMES