Skip navigation links
A C D E F G H I L N P R S T V X 

A

AbstractDocumentFormatter - Class in fr.opensagres.xdocreport.template.formatter
 
AbstractDocumentFormatter() - Constructor for class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter
 
AbstractDocumentFormatter.DirectiveToParse - Enum in fr.opensagres.xdocreport.template.formatter
 
AbstractFieldsMetadataClassSerializer - Class in fr.opensagres.xdocreport.template.formatter
Abstract class for Fields metadata serializer.
AbstractFieldsMetadataClassSerializer(String, String) - Constructor for class fr.opensagres.xdocreport.template.formatter.AbstractFieldsMetadataClassSerializer
 
AbstractTemplateEngine - Class in fr.opensagres.xdocreport.template
 
AbstractTemplateEngine() - Constructor for class fr.opensagres.xdocreport.template.AbstractTemplateEngine
 
AbstractTemplateEngineConfiguration - Class in fr.opensagres.xdocreport.template.config
 
AbstractTemplateEngineConfiguration() - Constructor for class fr.opensagres.xdocreport.template.config.AbstractTemplateEngineConfiguration
 
Activator - Class in fr.opensagres.xdocreport.template.internal.osgi
OSGi Activator to initialize/dispose template engine registry when bundle start/stop.
Activator() - Constructor for class fr.opensagres.xdocreport.template.internal.osgi.Activator
 
addCustomFormatter(ICustomFormatter) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Add custom formatter.
addField(String, Boolean, String, String, Boolean) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
addFieldAsImage(String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Add a field name which is considered as an image.
addFieldAsImage(String, boolean) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Add a field name which is considered as an image.
addFieldAsImage(String, NullImageBehaviour) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Add a field name which is considered as an image.
addFieldAsImage(String, NullImageBehaviour, boolean) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Add a field name which is considered as an image.
addFieldAsImage(String, String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Add a field name which is considered as an image.
addFieldAsImage(String, String, boolean) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
addFieldAsImage(String, String, NullImageBehaviour) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
addFieldAsImage(String, String, NullImageBehaviour, boolean) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Add a field name which is considered as an image.
addFieldAsList(String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Add a field name which belongs to a list.
addFieldAsTextStyling(String, SyntaxKind) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Add a field name which can contains text stylink (Html, Wikipedia, etc..).
addFieldAsTextStyling(String, SyntaxKind, boolean) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Add a field name which can contains text stylink (Html, Wikipedia, etc..).
addFieldAsTextStyling(String, String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Add a field name which can contains text stylink (Html, Wikipedia, etc..).
addFieldAsTextStyling(String, String, boolean) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Add a field name which can contains text stylink (Html, Wikipedia, etc..).
addFieldName(String, boolean) - Method in class fr.opensagres.xdocreport.template.FieldsExtractor
 
addFieldReplacement(String, String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Add field replacement.
addMapping(String, String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldReplacementFormatter
 

C

characters(char[], int, int) - Method in class fr.opensagres.xdocreport.template.formatter.sax.FieldsMetadataContentHandler
 
compare(FieldMetadata, FieldMetadata) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadataComparator
 
compare(String, String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsNameComparator
 
containsInterpolation(String) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
CONTEXT_KEY - Static variable in class fr.opensagres.xdocreport.template.TemplateContextHelper
 
create() - Static method in class fr.opensagres.xdocreport.template.FieldsExtractor
 
createContext() - Method in interface fr.opensagres.xdocreport.template.ITemplateEngine
Create a new context to register Java model.
createContext(Map<String, Object>) - Method in interface fr.opensagres.xdocreport.template.ITemplateEngine
Create a new context to register Java model from the given Map.
createField(String, boolean) - Method in class fr.opensagres.xdocreport.template.FieldsExtractor
 
createTemplateEngine() - Method in interface fr.opensagres.xdocreport.template.discovery.ITemplateEngineDiscovery
Returns the default template engine to use for report generation when an IXDocReport is created with XDocReportRegistry#loadReport(java.io.InputStream) without specifying the template engine.
customFormat(String, IDocumentFormatter) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Format the given content by using custom formatter.

D

DEFAULT_AFTER_ROW_TOKEN - Static variable in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
DEFAULT_AFTER_TABLE_CELL_TOKEN - Static variable in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
DEFAULT_AFTER_TABLE_TOKEN - Static variable in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
DEFAULT_BEFORE_ROW_TOKEN - Static variable in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
DEFAULT_BEFORE_TABLE_CELL_TOKEN - Static variable in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
DEFAULT_BEFORE_TABLE_TOKEN - Static variable in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
DESCRIPTION_ELT - Static variable in class fr.opensagres.xdocreport.template.formatter.XMLFieldsConstants
 
DESCRIPTION_END_ELT - Static variable in class fr.opensagres.xdocreport.template.formatter.XMLFieldsConstants
 
DESCRIPTION_START_ELT - Static variable in class fr.opensagres.xdocreport.template.formatter.XMLFieldsConstants
 
Directive - Class in fr.opensagres.xdocreport.template.formatter
 
Directive(Directive, String, String) - Constructor for class fr.opensagres.xdocreport.template.formatter.Directive
 
Directive.DirectiveType - Enum in fr.opensagres.xdocreport.template.formatter
 
DirectivesStack - Class in fr.opensagres.xdocreport.template.formatter
 
DirectivesStack() - Constructor for class fr.opensagres.xdocreport.template.formatter.DirectivesStack
 
doDispose() - Method in class fr.opensagres.xdocreport.template.registry.FieldsMetadataClassSerializerRegistry
 
doDispose() - Method in class fr.opensagres.xdocreport.template.registry.TemplateEngineRegistry
 
DynamicBean - Class in fr.opensagres.xdocreport.template.internal
DynamicBean is used to emulate Java Bean.
DynamicBean() - Constructor for class fr.opensagres.xdocreport.template.internal.DynamicBean
 

E

EMPTY - Static variable in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
END_CDATA - Static variable in class fr.opensagres.xdocreport.template.formatter.XMLFieldsConstants
 
endElement(String, String, String) - Method in class fr.opensagres.xdocreport.template.formatter.sax.FieldsMetadataContentHandler
 
escapeXML() - Method in class fr.opensagres.xdocreport.template.config.AbstractTemplateEngineConfiguration
 
escapeXML() - Method in interface fr.opensagres.xdocreport.template.config.ITemplateEngineConfiguration
 
existsReport(String) - Method in interface fr.opensagres.xdocreport.template.cache.ITemplateCacheInfoProvider
 
extractFields(IEntryReaderProvider, String, FieldsExtractor) - Method in class fr.opensagres.xdocreport.template.AbstractTemplateEngine
 
extractFields(Reader, String, FieldsExtractor) - Method in interface fr.opensagres.xdocreport.template.ITemplateEngine
 
extractFields(IEntryReaderProvider, String, FieldsExtractor) - Method in interface fr.opensagres.xdocreport.template.ITemplateEngine
 
extractItemNameList(String, String, boolean) - Method in class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter
 
extractItemNameList(String, String, boolean) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
extractListDirectiveInfo(String, DirectivesStack) - Method in class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter
 
extractListDirectiveInfo(String, DirectivesStack) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
extractListDirectiveInfo(String, DirectivesStack, boolean) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
extractModelTokenPrefix(String) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 

F

FIELD_ELT - Static variable in class fr.opensagres.xdocreport.template.formatter.XMLFieldsConstants
 
FIELD_END_ELT - Static variable in class fr.opensagres.xdocreport.template.formatter.XMLFieldsConstants
 
FIELD_TAG_START_ELT - Static variable in class fr.opensagres.xdocreport.template.formatter.XMLFieldsConstants
 
FieldExtractor - Class in fr.opensagres.xdocreport.template
 
FieldExtractor(String, boolean) - Constructor for class fr.opensagres.xdocreport.template.FieldExtractor
 
FieldMetadata - Annotation Type in fr.opensagres.xdocreport.template.annotations
This annotation should be attached to getter method which is called from Velocity or Freemarker Otherwise it will have no effect
FieldMetadata - Class in fr.opensagres.xdocreport.template.formatter
Field metadata.
FieldMetadata(FieldsMetadata, String, boolean, String, String, boolean) - Constructor for class fr.opensagres.xdocreport.template.formatter.FieldMetadata
 
FieldMetadataImage - Class in fr.opensagres.xdocreport.template.formatter
 
FieldMetadataImage(String, String) - Constructor for class fr.opensagres.xdocreport.template.formatter.FieldMetadataImage
 
FieldReplacementFormatter - Class in fr.opensagres.xdocreport.template.formatter
Custom replacement of merge/input field which is done while preprocessing step.
FieldReplacementFormatter() - Constructor for class fr.opensagres.xdocreport.template.formatter.FieldReplacementFormatter
 
fields - Variable in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
FIELDS_ELT - Static variable in class fr.opensagres.xdocreport.template.formatter.XMLFieldsConstants
 
FIELDS_END_ELT - Static variable in class fr.opensagres.xdocreport.template.formatter.XMLFieldsConstants
 
FIELDS_TAG_START_ELT - Static variable in class fr.opensagres.xdocreport.template.formatter.XMLFieldsConstants
 
fieldsAsImage - Variable in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
fieldsAsList - Variable in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
fieldsAsTextStyling - Variable in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
FieldsExtractor<T extends FieldExtractor> - Class in fr.opensagres.xdocreport.template
Fields extractor used to extract fields declared in the XML entries template.
FieldsExtractor() - Constructor for class fr.opensagres.xdocreport.template.FieldsExtractor
 
FieldsExtractor(boolean) - Constructor for class fr.opensagres.xdocreport.template.FieldsExtractor
 
FieldsMetadata - Class in fr.opensagres.xdocreport.template.formatter
Fields Metadata is used in the preprocessing step to modify some XML entries like generate script (Freemarker, Velocity...) for loop for Table row, generate script for Image...
FieldsMetadata() - Constructor for class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
FieldsMetadata(TemplateEngineKind) - Constructor for class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
FieldsMetadata(String) - Constructor for class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
FieldsMetadataClassSerializerRegistry - Class in fr.opensagres.xdocreport.template.registry
 
FieldsMetadataClassSerializerRegistry() - Constructor for class fr.opensagres.xdocreport.template.registry.FieldsMetadataClassSerializerRegistry
 
FieldsMetadataComparator - Class in fr.opensagres.xdocreport.template.formatter
 
FieldsMetadataComparator() - Constructor for class fr.opensagres.xdocreport.template.formatter.FieldsMetadataComparator
 
FieldsMetadataContentHandler - Class in fr.opensagres.xdocreport.template.formatter.sax
 
FieldsMetadataContentHandler() - Constructor for class fr.opensagres.xdocreport.template.formatter.sax.FieldsMetadataContentHandler
 
FieldsMetadataXMLSerializer - Class in fr.opensagres.xdocreport.template.formatter
Fields metadata serializer used to load FieldsMetadata from XML and serialize FieldsMetadata to XML.
FieldsMetadataXMLSerializer() - Constructor for class fr.opensagres.xdocreport.template.formatter.FieldsMetadataXMLSerializer
 
FieldsNameComparator - Class in fr.opensagres.xdocreport.template.formatter
 
FieldsNameComparator() - Constructor for class fr.opensagres.xdocreport.template.formatter.FieldsNameComparator
 
format(String, IDocumentFormatter) - Method in class fr.opensagres.xdocreport.template.formatter.FieldReplacementFormatter
 
format(String, IDocumentFormatter) - Method in interface fr.opensagres.xdocreport.template.formatter.ICustomFormatter
returns the result of the format of teh given content coming from input/merge field.
formatAsCallTextStyling(long, String, String, String, boolean, String, String) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
formatAsFieldItemList(String, String, boolean) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
formatAsSimpleField(boolean, String...) - Method in class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter
 
formatAsSimpleField(boolean, boolean, String...) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
formatAsSimpleField(boolean, String...) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
formatAsTextStylingField(long, String) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
formatDirective(String, String, String) - Static method in class fr.opensagres.xdocreport.template.formatter.Directive
 
fr.opensagres.xdocreport.template - package fr.opensagres.xdocreport.template
 
fr.opensagres.xdocreport.template.annotations - package fr.opensagres.xdocreport.template.annotations
 
fr.opensagres.xdocreport.template.cache - package fr.opensagres.xdocreport.template.cache
 
fr.opensagres.xdocreport.template.config - package fr.opensagres.xdocreport.template.config
 
fr.opensagres.xdocreport.template.discovery - package fr.opensagres.xdocreport.template.discovery
 
fr.opensagres.xdocreport.template.formatter - package fr.opensagres.xdocreport.template.formatter
 
fr.opensagres.xdocreport.template.formatter.sax - package fr.opensagres.xdocreport.template.formatter.sax
 
fr.opensagres.xdocreport.template.internal - package fr.opensagres.xdocreport.template.internal
 
fr.opensagres.xdocreport.template.internal.osgi - package fr.opensagres.xdocreport.template.internal.osgi
 
fr.opensagres.xdocreport.template.registry - package fr.opensagres.xdocreport.template.registry
 
fr.opensagres.xdocreport.template.utils - package fr.opensagres.xdocreport.template.utils
 

G

get(String) - Method in interface fr.opensagres.xdocreport.template.IContext
Get the Java object with the given key which was registered and null otherwise.
getAfterRowToken() - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
getAfterTableCellToken() - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
getAfterTableToken() - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
getBeforeRowToken() - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
getBeforeTableCellToken() - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
getBeforeTableToken() - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
getBehaviour() - Method in class fr.opensagres.xdocreport.template.formatter.FieldMetadata
Returns the "field" behavior to use when the stream of the image is null.
getBehaviour() - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Returns the "global" behaviour to use when the stream of the image is null.
getCachedTemplateName(String, String) - Static method in class fr.opensagres.xdocreport.template.utils.TemplateUtils
Returns the template cache name used to cache the given entry name (which is a template) of the given report id.
getConfiguration() - Method in class fr.opensagres.xdocreport.template.AbstractTemplateEngine
 
getConfiguration() - Method in interface fr.opensagres.xdocreport.template.ITemplateEngine
 
getContextMap() - Method in interface fr.opensagres.xdocreport.template.IContext
 
getCustomFormatter() - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Returns list of custom formatters and null otherwise.
getDefaultTemplateEngine() - Method in class fr.opensagres.xdocreport.template.registry.TemplateEngineRegistry
 
getDefineDirective(String, String) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
getDescription() - Method in class fr.opensagres.xdocreport.template.formatter.AbstractFieldsMetadataClassSerializer
 
getDescription() - Method in class fr.opensagres.xdocreport.template.formatter.FieldMetadata
 
getDescription() - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Returns the description of fields metadata.
getDirectiveToParse(int, int, int, int) - Method in class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter
 
getDocumentFormatter() - Method in interface fr.opensagres.xdocreport.template.ITemplateEngine
 
getElseDirective() - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
getEndDirective() - Method in class fr.opensagres.xdocreport.template.formatter.Directive
 
getEndDocumentDirective() - Method in class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter
 
getEndDocumentDirective() - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
getEndIfDirective(String) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
getEndLoopDirective(String) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
getEndNoParse(IDocumentFormatter, FieldsMetadata) - Static method in class fr.opensagres.xdocreport.template.formatter.Directive
 
getEndNoParse() - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
getEntryName(String, int) - Static method in class fr.opensagres.xdocreport.template.utils.TemplateUtils
Returns the entry name of of the given cached template name.
getFieldAsImage(String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
getFieldAsTextStyling(String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Returns the fields metadata as text styling from the given content and null otherwise.
getFieldName(String, String) - Method in class fr.opensagres.xdocreport.template.formatter.AbstractFieldsMetadataClassSerializer
 
getFieldName() - Method in class fr.opensagres.xdocreport.template.formatter.FieldMetadata
Returns the field name.
getFieldName() - Method in class fr.opensagres.xdocreport.template.formatter.FieldMetadataImage
 
getFields() - Method in class fr.opensagres.xdocreport.template.FieldsExtractor
 
getFields() - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Returns list of fields metadata.
getFieldsAsImage() - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Returns list of fields name which are considered as an image.
getFieldsAsList() - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Returns list of fields name which belongs to a list.
getFieldsAsTextStyling() - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Returns list of fields name which can contains text styling.
getFieldsMetadata() - Method in class fr.opensagres.xdocreport.template.formatter.sax.FieldsMetadataContentHandler
 
getFunctionDirective(boolean, String, String, String...) - Method in class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter
 
getFunctionDirective(String, String, String...) - Method in class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter
 
getFunctionDirective(boolean, boolean, String, String, String...) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
getFunctionDirective(boolean, String, String, String...) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
getFunctionDirective(String, String, String...) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
getId() - Method in class fr.opensagres.xdocreport.template.formatter.AbstractFieldsMetadataClassSerializer
 
getId() - Method in interface fr.opensagres.xdocreport.template.ITemplateEngine
Return the identifier of the template engine.
getImageFieldName(String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
getImageName() - Method in class fr.opensagres.xdocreport.template.formatter.FieldMetadata
Returns the image name.
getImageName() - Method in class fr.opensagres.xdocreport.template.formatter.FieldMetadataImage
 
getIndexOfScript(String) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
getIndexReportEntryName(String) - Static method in class fr.opensagres.xdocreport.template.utils.TemplateUtils
Returns the last index of the token '!'
getInstance() - Static method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadataComparator
 
getInstance() - Static method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadataXMLSerializer
 
getInstance() - Static method in class fr.opensagres.xdocreport.template.formatter.FieldsNameComparator
 
getItem() - Method in class fr.opensagres.xdocreport.template.formatter.LoopDirective
 
getItemToken() - Method in class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter
 
getKind() - Method in interface fr.opensagres.xdocreport.template.ITemplateEngine
Returns the template engien kind (Freemarker, Velocity..)
getLoopCountDirective(String) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
getMinIndex(int, int, int, int) - Method in class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter
 
getName() - Method in class fr.opensagres.xdocreport.template.FieldExtractor
 
getNewText() - Method in class fr.opensagres.xdocreport.template.config.ReplaceText
 
getOldText() - Method in class fr.opensagres.xdocreport.template.config.ReplaceText
 
getParent() - Method in class fr.opensagres.xdocreport.template.formatter.Directive
 
getRegistry() - Static method in class fr.opensagres.xdocreport.template.registry.FieldsMetadataClassSerializerRegistry
 
getRegistry() - Static method in class fr.opensagres.xdocreport.template.registry.TemplateEngineRegistry
 
getReplacment() - Method in class fr.opensagres.xdocreport.template.config.AbstractTemplateEngineConfiguration
 
getReplacment() - Method in interface fr.opensagres.xdocreport.template.config.ITemplateEngineConfiguration
 
getReportId(String, int) - Static method in class fr.opensagres.xdocreport.template.utils.TemplateUtils
Returns the report of of the given cached template name.
getSequence() - Method in class fr.opensagres.xdocreport.template.formatter.LoopDirective
 
getSerializer(String) - Method in class fr.opensagres.xdocreport.template.registry.FieldsMetadataClassSerializerRegistry
 
getSetDirective(String, String) - Method in class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter
 
getSetDirective(String, String, boolean) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
getSetDirective(String, String) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
getStartDirective() - Method in class fr.opensagres.xdocreport.template.formatter.Directive
 
getStartDocumentDirective() - Method in class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter
 
getStartDocumentDirective() - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
getStartIfDirective(String) - Method in class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter
 
getStartIfDirective(String) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
getStartIfDirective(String, boolean) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
getStartLoopDirective(String) - Method in class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter
 
getStartLoopDirective(String) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
getStartLoopDirective(String, String) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
getStartNoParse(IDocumentFormatter, FieldsMetadata) - Static method in class fr.opensagres.xdocreport.template.formatter.Directive
 
getStartNoParse() - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
getSyntaxKind() - Method in class fr.opensagres.xdocreport.template.formatter.FieldMetadata
 
getTemplateCacheInfo(String, String) - Method in interface fr.opensagres.xdocreport.template.cache.ITemplateCacheInfoProvider
 
getTemplateCacheInfo(ITemplateCacheInfoProvider, String) - Static method in class fr.opensagres.xdocreport.template.utils.TemplateUtils
 
getTemplateCacheInfoProvider() - Method in class fr.opensagres.xdocreport.template.AbstractTemplateEngine
 
getTemplateCacheInfoProvider() - Method in interface fr.opensagres.xdocreport.template.ITemplateEngine
 
getTemplateEngine(TemplateEngineKind) - Method in class fr.opensagres.xdocreport.template.registry.TemplateEngineRegistry
 
getTemplateEngine(String) - Method in class fr.opensagres.xdocreport.template.registry.TemplateEngineRegistry
 
getTemplateEngine(IContext) - Static method in class fr.opensagres.xdocreport.template.TemplateContextHelper
Retrieves the template engine from the given context.
getTemplateEngineKind() - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Returns the template engine kind.
getTemplateEngineKinds() - Method in class fr.opensagres.xdocreport.template.registry.TemplateEngineRegistry
 
getTemplateEngines() - Method in class fr.opensagres.xdocreport.template.registry.TemplateEngineRegistry
 
getTemplateEnginesDiscoveryCache() - Method in class fr.opensagres.xdocreport.template.registry.TemplateEngineRegistry
 
getType() - Method in class fr.opensagres.xdocreport.template.formatter.Directive
 
getType() - Method in class fr.opensagres.xdocreport.template.formatter.IfDirective
 
getType() - Method in class fr.opensagres.xdocreport.template.formatter.LoopDirective
 
getVariableName(long) - Method in class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter
 

H

HAS_DIRECTIVE - Static variable in class fr.opensagres.xdocreport.template.formatter.XMLFieldsConstants
 
hasDirective(String) - Method in interface fr.opensagres.xdocreport.template.formatter.IDocumentFormatter
 
hasFieldsAsImage() - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Returns true if there are fields as image and false otherwise.

I

IContext - Interface in fr.opensagres.xdocreport.template
Context used to register a Java model with given key.
ICustomFormatter - Interface in fr.opensagres.xdocreport.template.formatter
Custom formatter field which is used to format input/mergefield while preprocessing step.
IDocumentFormatter - Interface in fr.opensagres.xdocreport.template.formatter
 
IfDirective - Class in fr.opensagres.xdocreport.template.formatter
 
IfDirective(Directive, String, String) - Constructor for class fr.opensagres.xdocreport.template.formatter.IfDirective
 
IFieldsMetadataClassSerializer - Interface in fr.opensagres.xdocreport.template.formatter
Fields metadata serializer used to load FieldsMetadata from Java Class model.
IMAGE_NAME_ATTR - Static variable in class fr.opensagres.xdocreport.template.formatter.XMLFieldsConstants
 
IMAGE_REGISTRY_KEY - Static variable in class fr.opensagres.xdocreport.template.TemplateContextHelper
 
ImageMetadata - Annotation Type in fr.opensagres.xdocreport.template.annotations
 
IPropertyDescriptorFilter - Interface in fr.opensagres.xdocreport.template.formatter
 
isDefault(ITemplateEngine) - Method in class fr.opensagres.xdocreport.template.registry.TemplateEngineRegistry
 
isEvaluateEngineOnlyForFields(IDocumentFormatter, FieldsMetadata) - Static method in class fr.opensagres.xdocreport.template.formatter.Directive
 
isEvaluateEngineOnlyForFields() - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Returns true if evaluation of the template engine should be done only for directive inserted in a field (MergeField for MS Word, Text-Inpout for ODT, etc) and false otherwise.
isFieldAsImage(String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
isFieldNameStartsWithUpperCase() - Method in interface fr.opensagres.xdocreport.template.ITemplateEngine
 
isImageType() - Method in class fr.opensagres.xdocreport.template.formatter.FieldMetadata
Returns true if field is image type and false otherwise.
isList() - Method in class fr.opensagres.xdocreport.template.FieldExtractor
 
isListType() - Method in class fr.opensagres.xdocreport.template.formatter.FieldMetadata
Returns true if field is list type and false otherwise.
isModelField(String, String) - Method in class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter
 
isSyntaxWithDirective() - Method in class fr.opensagres.xdocreport.template.formatter.FieldMetadata
 
isUseImageSize() - Method in class fr.opensagres.xdocreport.template.formatter.FieldMetadata
 
isUseImageSize() - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
isUseTemplateCache(String) - Method in class fr.opensagres.xdocreport.template.AbstractTemplateEngine
 
ITemplateCacheInfoProvider - Interface in fr.opensagres.xdocreport.template.cache
Template cache information provider.
ITemplateEngine - Interface in fr.opensagres.xdocreport.template
Template engine used to merge Java model with some entries (XML file) from an XML document archive.
ITemplateEngineConfiguration - Interface in fr.opensagres.xdocreport.template.config
 
ITemplateEngineDiscovery - Interface in fr.opensagres.xdocreport.template.discovery
Discovery used to create template engine instance.

L

LIST_ATTR - Static variable in class fr.opensagres.xdocreport.template.formatter.XMLFieldsConstants
 
load(FieldsMetadata, String, Class<?>) - Method in class fr.opensagres.xdocreport.template.formatter.AbstractFieldsMetadataClassSerializer
 
load(FieldsMetadata, String, Class<?>, boolean) - Method in class fr.opensagres.xdocreport.template.formatter.AbstractFieldsMetadataClassSerializer
 
load(String, Class<?>) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Load simple fields metadata in the given fieldsMetadata by using the given key and Java Class.
load(String, Class<?>, boolean) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Load simple/list fields metadata in the given fieldsMetadata by using the given key and Java Class.
load(Reader) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadataXMLSerializer
Load fields metadata in the given FieldsMetadata from the given XML reader.
load(InputStream) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadataXMLSerializer
Load fields metadata in the given FieldsMetadata from the given XML reader.
load(FieldsMetadata, String, Class<?>) - Method in interface fr.opensagres.xdocreport.template.formatter.IFieldsMetadataClassSerializer
Load simple fields metadata in the given fieldsMetadata by using the given key and Java Class.
load(FieldsMetadata, String, Class<?>, boolean) - Method in interface fr.opensagres.xdocreport.template.formatter.IFieldsMetadataClassSerializer
Load simple/list fields metadata in the given fieldsMetadata by using the given key and Java Class.
LoopDirective - Class in fr.opensagres.xdocreport.template.formatter
 
LoopDirective(Directive, String, String, String, String) - Constructor for class fr.opensagres.xdocreport.template.formatter.LoopDirective
 

N

NAME_ATTR - Static variable in class fr.opensagres.xdocreport.template.formatter.XMLFieldsConstants
 
NO_ESCAPE - Static variable in class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter
 
NullImageBehaviour - Enum in fr.opensagres.xdocreport.template.formatter
 

P

peekDirective(Directive.DirectiveType) - Method in class fr.opensagres.xdocreport.template.formatter.DirectivesStack
 
peekOrNull() - Method in class fr.opensagres.xdocreport.template.formatter.DirectivesStack
 
populate(Collection<ReplaceText>) - Method in class fr.opensagres.xdocreport.template.config.AbstractTemplateEngineConfiguration
 
process(String, String, IEntryReaderProvider, IEntryWriterProvider, IContext) - Method in class fr.opensagres.xdocreport.template.AbstractTemplateEngine
 
process(String, String, IEntryReaderProvider, Writer, IContext) - Method in class fr.opensagres.xdocreport.template.AbstractTemplateEngine
 
process(String, IContext, Reader, Writer) - Method in class fr.opensagres.xdocreport.template.AbstractTemplateEngine
 
process(String, String, IEntryReaderProvider, IEntryWriterProvider, IContext) - Method in interface fr.opensagres.xdocreport.template.ITemplateEngine
Merge Java model coming from the given context with the XML file entryName of the given document archive and modify the entry of the document archive.
process(String, String, IEntryReaderProvider, Writer, IContext) - Method in interface fr.opensagres.xdocreport.template.ITemplateEngine
 
process(String, IContext, Reader, Writer) - Method in interface fr.opensagres.xdocreport.template.ITemplateEngine
Merge Java model coming from the given context with the given reader and register the merge result in the given writer.
process(String, IContext, Writer) - Method in interface fr.opensagres.xdocreport.template.ITemplateEngine
Merge Java model coming from the given context with the given template name and register the merge result in the given writer.
processNoCache(String, IContext, Reader, Writer) - Method in class fr.opensagres.xdocreport.template.AbstractTemplateEngine
Merge the given template with the given context and writes the result in the given writer.
processWithCache(String, IContext, Writer) - Method in class fr.opensagres.xdocreport.template.AbstractTemplateEngine
Merge the given template with the given context and writes the result in the given writer.
put(String, Object) - Method in interface fr.opensagres.xdocreport.template.IContext
Register a Java object with the given key.
putContext(IContext) - Static method in class fr.opensagres.xdocreport.template.TemplateContextHelper
Register the given context in the given context.
putContextForDottedKey(IContext, String, Object) - Static method in class fr.opensagres.xdocreport.template.utils.TemplateUtils
If key has '.' character in the key (ex : project.name), this method create a DynamicBean instance to emulate the bean Project#getName().
putMap(Map<String, Object>) - Method in interface fr.opensagres.xdocreport.template.IContext
 
putTemplateEngine(IContext, ITemplateEngine) - Static method in class fr.opensagres.xdocreport.template.TemplateContextHelper
Register the given template engine in the given context.

R

registerInstance(IFieldsMetadataClassSerializer) - Method in class fr.opensagres.xdocreport.template.registry.FieldsMetadataClassSerializerRegistry
 
registerInstance(ITemplateEngineDiscovery) - Method in class fr.opensagres.xdocreport.template.registry.TemplateEngineRegistry
 
ReplaceText - Class in fr.opensagres.xdocreport.template.config
 
ReplaceText(String, String) - Constructor for class fr.opensagres.xdocreport.template.config.ReplaceText
 

S

save(FieldsMetadata, Writer) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadataXMLSerializer
Serialize as XML the given FieldsMetadata to the given XML writer.
save(FieldsMetadata, Writer, boolean) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadataXMLSerializer
Serialize as XML the given FieldsMetadata to the given XML writer.
save(FieldsMetadata, Writer, boolean, boolean) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadataXMLSerializer
Serialize as XML the given FieldsMetadata to the given XML writer.
save(FieldsMetadata, OutputStream, boolean, boolean) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadataXMLSerializer
Serialize as XML the given FieldsMetadata to the given XML output stream.
saveXML(Writer) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Serialize as XML without indentation the fields metadata to the given XML writer.
saveXML(Writer, boolean) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Serialize as XML the fields metadata to the given XML writer.
saveXML(Writer, boolean, boolean) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Serialize as XML the fields metadata to the given XML writer.
saveXML(OutputStream) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Serialize as XML without indentation the fields metadata to the given OutputStream.
saveXML(OutputStream, boolean) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Serialize as XML the fields metadata to the given OutputStream.
setAfterRowToken(String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
setAfterTableCellToken(String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
setAfterTableToken(String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
setBeforeRowToken(String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
setBeforeTableCellToken(String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
setBeforeTableToken(String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
setBehaviour(NullImageBehaviour) - Method in class fr.opensagres.xdocreport.template.formatter.FieldMetadata
Set the "field" behaviour to use when the stream of the image is null.
setBehaviour(NullImageBehaviour) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Set the "global" behaviour to use when the stream of the image is null.
setConfiguration(ITemplateEngineConfiguration) - Method in class fr.opensagres.xdocreport.template.AbstractTemplateEngine
 
setConfiguration(ITemplateEngineConfiguration) - Method in interface fr.opensagres.xdocreport.template.ITemplateEngine
 
setDefaultTemplateEngine(ITemplateEngine) - Method in class fr.opensagres.xdocreport.template.registry.TemplateEngineRegistry
 
setDescription(String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldMetadata
 
setDescription(String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Set the description of fields metadata.
setEndDocumentDirective(String) - Method in class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter
 
setEvaluateEngineOnlyForFields(boolean) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Set true if evaluation of the template engine should be done only for directive inserted in a field (MergeField for MS Word, Text-Inpout for ODT, etc) and false otherwises.
setFilter(IPropertyDescriptorFilter) - Method in class fr.opensagres.xdocreport.template.formatter.AbstractFieldsMetadataClassSerializer
 
setImageName(String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldMetadata
Set image name.
setListType(boolean) - Method in class fr.opensagres.xdocreport.template.formatter.FieldMetadata
Set true if field is list type and false otherwise.
setStartDocumentDirective(String) - Method in class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter
 
setSyntaxKind(String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldMetadata
 
setSyntaxWithDirective(boolean) - Method in class fr.opensagres.xdocreport.template.formatter.FieldMetadata
 
setTemplateCacheInfoProvider(ITemplateCacheInfoProvider) - Method in class fr.opensagres.xdocreport.template.AbstractTemplateEngine
 
setTemplateCacheInfoProvider(ITemplateCacheInfoProvider) - Method in interface fr.opensagres.xdocreport.template.ITemplateEngine
 
setTemplateEngineKind(String) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
Set the template engine kind.
setUseImageSize(boolean) - Method in class fr.opensagres.xdocreport.template.formatter.FieldMetadata
 
setUseImageSize(boolean) - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
setValue(String[], Object, int) - Method in class fr.opensagres.xdocreport.template.internal.DynamicBean
 
start(BundleContext) - Method in class fr.opensagres.xdocreport.template.internal.osgi.Activator
 
START_CDATA - Static variable in class fr.opensagres.xdocreport.template.formatter.XMLFieldsConstants
 
startDocument() - Method in class fr.opensagres.xdocreport.template.formatter.sax.FieldsMetadataContentHandler
 
startElement(String, String, String, Attributes) - Method in class fr.opensagres.xdocreport.template.formatter.sax.FieldsMetadataContentHandler
 
stop(BundleContext) - Method in class fr.opensagres.xdocreport.template.internal.osgi.Activator
 
SYNTAX_KIND_ATTR - Static variable in class fr.opensagres.xdocreport.template.formatter.XMLFieldsConstants
 

T

TEMPLATE_ENGINE_KEY - Static variable in class fr.opensagres.xdocreport.template.TemplateContextHelper
 
TEMPLATE_ENGINE_KIND_ATTR - Static variable in class fr.opensagres.xdocreport.template.formatter.XMLFieldsConstants
 
TemplateContextHelper - Class in fr.opensagres.xdocreport.template
Helper to register and retrieves default Java model for the IContext.
TemplateContextHelper() - Constructor for class fr.opensagres.xdocreport.template.TemplateContextHelper
 
TemplateEngineKind - Enum in fr.opensagres.xdocreport.template
 
TemplateEngineRegistry - Class in fr.opensagres.xdocreport.template.registry
Template engine registry stores instance of ITemplateEngine for template engine kind (Freemarker, Velocity) and document kind (odt, docx..)
TemplateEngineRegistry() - Constructor for class fr.opensagres.xdocreport.template.registry.TemplateEngineRegistry
 
TemplateUtils - Class in fr.opensagres.xdocreport.template.utils
Utilities for template cache, context.
TemplateUtils() - Constructor for class fr.opensagres.xdocreport.template.utils.TemplateUtils
 
test(PropertyDescriptor) - Method in interface fr.opensagres.xdocreport.template.formatter.IPropertyDescriptorFilter
 
TEXT_STYLING_REGISTRY_KEY - Static variable in class fr.opensagres.xdocreport.template.TemplateContextHelper
 
toString() - Method in class fr.opensagres.xdocreport.template.formatter.Directive
 
toString() - Method in class fr.opensagres.xdocreport.template.formatter.FieldsMetadata
 
TRANSFORM_METHOD - Static variable in class fr.opensagres.xdocreport.template.TemplateContextHelper
 

V

valueOf(String) - Static method in enum fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter.DirectiveToParse
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum fr.opensagres.xdocreport.template.formatter.Directive.DirectiveType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum fr.opensagres.xdocreport.template.formatter.NullImageBehaviour
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum fr.opensagres.xdocreport.template.TemplateEngineKind
Returns the enum constant of this type with the specified name.
values() - Static method in enum fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter.DirectiveToParse
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum fr.opensagres.xdocreport.template.formatter.Directive.DirectiveType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum fr.opensagres.xdocreport.template.formatter.NullImageBehaviour
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum fr.opensagres.xdocreport.template.TemplateEngineKind
Returns an array containing the constants of this enum type, in the order they are declared.

X

XML_DECLARATION - Static variable in class fr.opensagres.xdocreport.template.formatter.XMLFieldsConstants
 
XML_DECLARATION_AS_JAVA_STRING - Static variable in class fr.opensagres.xdocreport.template.formatter.XMLFieldsConstants
 
XMLFieldsConstants - Class in fr.opensagres.xdocreport.template.formatter
 
XMLFieldsConstants() - Constructor for class fr.opensagres.xdocreport.template.formatter.XMLFieldsConstants
 
A C D E F G H I L N P R S T V X 
Skip navigation links

Copyright © 2019. All Rights Reserved.