Docmosis API 4.5.0

com.docmosis.template.analysis.structure
Interface TemplateStructureElement


public interface TemplateStructureElement

This class provides a simple interpretation of an element of a template that has been loaded into Docmosis. This element may have children making it a recursive structure which can then be used with a TemplateStructureProcessor to perform different analyses or renderings of the structure of a template.

See Also:
TemplateStructureProcessor

Method Summary
 boolean canHaveChildren()
           
 NestedStructureDetails getContainingNest()
          Get the containing nesting structure for this element.
 TemplateExpression getExpression()
          Get any template-expression associated with this field.
 String getName()
           
 String getOriginalFieldText()
          Get the original text of the element from the template
 List getSubStructures()
           
 boolean isArtificial()
          Determine if the element is artificially created by analysis processing.
 boolean isBarcode()
           
 boolean isConditionalSection()
           
 boolean isExpression()
           
 boolean isField()
           
 boolean isFunctionCall()
           
 boolean isHyperlink()
           
 boolean isImage()
           
 boolean isInHeaderOrFooter()
           
 boolean isRepeatingSection()
           
 boolean isTemplateReference()
           
 boolean isTemplateReferenceStatic()
           
 boolean isVariableGetField()
           
 boolean isVariableSetField()
           
 

Method Detail

getName

public String getName()

isInHeaderOrFooter

public boolean isInHeaderOrFooter()

isField

public boolean isField()

isBarcode

public boolean isBarcode()

isHyperlink

public boolean isHyperlink()

isRepeatingSection

public boolean isRepeatingSection()

isConditionalSection

public boolean isConditionalSection()

isImage

public boolean isImage()

canHaveChildren

public boolean canHaveChildren()

getSubStructures

public List getSubStructures()

isVariableGetField

public boolean isVariableGetField()

isVariableSetField

public boolean isVariableSetField()

isExpression

public boolean isExpression()

isFunctionCall

public boolean isFunctionCall()

isTemplateReference

public boolean isTemplateReference()

isTemplateReferenceStatic

public boolean isTemplateReferenceStatic()

isArtificial

public boolean isArtificial()
Determine if the element is artificially created by analysis processing. Typically that means the element can be ignored.


getContainingNest

public NestedStructureDetails getContainingNest()
Get the containing nesting structure for this element. This is only set if the field uses a "a.b.c" notation for its lookup term

Returns:
null if none applies.

getExpression

public TemplateExpression getExpression()
Get any template-expression associated with this field.

Returns:
null if there is none.

getOriginalFieldText

public String getOriginalFieldText()
Get the original text of the element from the template


Docmosis API 4.5.0

Copyright © 2014 Docmosis Pty Ltd. All Rights Reserved.