|
Docmosis API 4.8.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TemplateSection
This interface defines a section of a template. A template can be broken up recursively into section which have various attributes including a start and end index to help processing the template.
Method Summary | |
---|---|
boolean |
equals(Object other,
boolean ignorePosition)
Determine if this object is equal to the given object optionally ignoring positional information. |
long |
getEndIndex()
Get the index into the content of the last character of this section |
long |
getLength()
Determine the length of this section of the template (end - start) |
com.docmosis.template.analysis.ParsedField |
getParsedFieldDetails()
Get the parsed details for this field. |
long |
getPostAmbleStartIdx()
Get the start index of the post amble. |
long |
getPreAmbleEndIdx()
Get the end index of the pre amble. |
long |
getStartIndex()
Get the index into the content of the first character of this section |
TemplateSection[] |
getSubSections()
Get the sections contained by this section. |
boolean |
isArtificial()
Determine if this section is artificial, meaning it was created by Docmosis during analysis to assist with population. |
boolean |
isConditional()
Determine if this section is conditional |
boolean |
isContainer()
Determine if this section is a container section (meaning it can contain other sections). |
boolean |
isPopulable()
Determine if this section has items in it which may be candidates for population. |
boolean |
isRepeatable()
Determine if this section is repeatable |
boolean |
isSkipSection()
Determine if this section indicates a skip (and hence should be skipped). |
boolean |
skipPreAndPostAmble()
Determine if this section has pre and post amble sections that should be skipped during population. |
Method Detail |
---|
boolean isRepeatable()
boolean isConditional()
long getStartIndex()
long getEndIndex()
long getLength()
boolean isPopulable()
boolean isContainer()
TemplateSection[] getSubSections()
boolean skipPreAndPostAmble()
long getPreAmbleEndIdx()
long getPostAmbleStartIdx()
boolean isSkipSection()
boolean equals(Object other, boolean ignorePosition)
other
- the other object to compareignorePosition
- if true, positional information will not be compared
com.docmosis.template.analysis.ParsedField getParsedFieldDetails()
boolean isArtificial()
|
Docmosis API 4.8.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |