com.docmosis.template.analysis
Interface TemplateAnalysis

All Superinterfaces:

Serializable

public interface TemplateAnalysis

extends Serializable

A template anaylsis provides details about a (populatable) template that may help in processing the template (performance hints). It also may provide hints that can be used when constructing a DataProvider as to what forms of data might be required. This allows data providers to pre-fetch data based on specifics of the template it is populating.

Method Summary

TemplateField[]	getFields() Return only the fields in the template in the order they appear in the template.
long	getLength() Obtain the total size of the template.
String	getOriginalMD5() The the MD5 hash string that the template had at the time of storing.
TemplateSection[]	getSections() Get the breakdown of a template as a set of sections.
char[]	getStaticNewStyles() Get any new styles derived during analysis
boolean	hasDynamicTableStyling() Determine if this template has tables with dynamic styling.
boolean	hasTemplateErrors() Determine if the template has errors in it.

Method Detail

getSections

public TemplateSection[] getSections()

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

Returns:

the sections contained in this analysis or null.

getFields

public TemplateField[] getFields()

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

Returns:

null if there are no fields

getLength

public long getLength()

Obtain the total size of the template.

Returns:

the size of the template.

getOriginalMD5

public String getOriginalMD5()

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

Returns:

an MD5 hash string.

hasDynamicTableStyling

public boolean hasDynamicTableStyling()

Determine if this template has tables with dynamic styling.

Returns:

true if table dynamic styling been detected.

hasTemplateErrors

public boolean hasTemplateErrors()

Determine if the template has errors in it. Errors in the template mean it should NOT be used for merging with data, but the template can be used to produce a document showing where the template errors exist.

Returns:

true if the template has errors ("compile" errors).

getStaticNewStyles

public char[] getStaticNewStyles()

Get any new styles derived during analysis

Returns:

null if there are none.