|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TemplateAnalysis
A template analysis provides details about a (populable) 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 | |
---|---|
ExternalResourceCollection |
getExternalResources()
Get the external resource references detected in the template. |
com.docmosis.template.analysis.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 analysis stream. |
com.docmosis.template.analysis.list.ListStyles |
getListStyles()
Get a map of the list styles that are useful in population. |
com.docmosis.template.analysis.list.ListTree |
getListTree()
Get the ListTree describing relationships between numbered lists in the template |
TemplateAnalysis |
getMetaAnalysis()
Get the analysis of the Meta of the template. |
String |
getOriginalMD5()
The the MD5 hash string that the template had at the time of storing. |
boolean |
getProcessedAllowingPaddedFields()
Determine if this template was processed allowing fields to be padded (eg << abc >>) |
boolean |
getProcessedWithExternalConverter()
Determine if this template was processed with the external converter |
com.docmosis.template.analysis.TemplateSection[] |
getSections()
Get the breakdown of a template as a set of sections. |
char[] |
getStaticNewStyles()
Get any new styles derived during analysis |
TemplateAnalysis |
getStyleAnalysis()
Get the analysis of the styles of the template. |
MessageAndSuggestions[] |
getTemplateErrorMessages()
Get the error messages from the template (if any). |
com.docmosis.template.analysis.ImageAnalysis |
getTemplateImages()
Get information about the images in the template. |
com.docmosis.template.analysis.TextWritableSafeAreas |
getWritableSafeAreas()
Get the writable safe areas for validation |
boolean |
hasDynamicTableStyling()
Determine if this template has tables with dynamic styling. |
boolean |
hasExternalResourcesPermisionFailures()
|
boolean |
hasTableWithMergedNonBreakingRows()
Determine if tables are present with merged rows and the "don't-break row" property set. |
boolean |
hasTemplateErrors()
Determine if the template has errors in it. |
boolean |
hasTOC()
Determine if the template has a Table of Contents (TOC) |
boolean |
isCoordinatorTemplate()
|
Method Detail |
---|
com.docmosis.template.analysis.TemplateSection[] getSections()
com.docmosis.template.analysis.TemplateField[] getFields()
long getLength()
String getOriginalMD5()
boolean hasDynamicTableStyling()
boolean hasTemplateErrors()
MessageAndSuggestions[] getTemplateErrorMessages()
char[] getStaticNewStyles()
com.docmosis.template.analysis.ImageAnalysis getTemplateImages()
boolean hasTOC()
TemplateAnalysis getStyleAnalysis()
TemplateAnalysis getMetaAnalysis()
boolean hasTableWithMergedNonBreakingRows()
boolean getProcessedWithExternalConverter()
boolean getProcessedAllowingPaddedFields()
com.docmosis.template.analysis.TextWritableSafeAreas getWritableSafeAreas()
com.docmosis.template.analysis.list.ListTree getListTree()
com.docmosis.template.analysis.list.ListStyles getListStyles()
boolean isCoordinatorTemplate()
ExternalResourceCollection getExternalResources()
boolean hasExternalResourcesPermisionFailures()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |