com.ibm.pdp.engine
Interface IGenInfoBuilder


public interface IGenInfoBuilder


Field Summary
static java.lang.String copyright
           
 
Method Summary
 IBuilderTag addTag(int beginIndex, int endIndex, java.lang.String tagName)
           
 IBuilderTag addTag(int beginIndex, int endIndex, java.lang.String tagName, java.lang.String parentName)
           
 com.ibm.pdp.engine.IGeneratedInfo getGeneratedInfo()
           
 java.lang.String getProperty(java.lang.String name)
           
 IBuilderTag getRootTag()
           
 java.lang.CharSequence getText()
           
 IBuilderTag includingTag(int beginIndex, int endIndex)
           
 java.util.Iterator<java.lang.String> propertyNames()
           
 void removeTag(IBuilderTag tag)
          This method allow the user to remove only a tag.
 void removeTag(java.lang.String tagName)
          This method allow the user to remove a specific tag.
 void removeTagAndText(IBuilderTag tag)
          This method allow the user to remove a tag and the text in it.
 void removeTree(IBuilderTag rootTreeTag)
          This method allow the user to remove a tag and all its children, recursively.
 void removeTreeAndText(IBuilderTag rootTreeTag)
          This method allow the user to remove a tag and all its children, recursively.
 void setProperty(java.lang.String name, java.lang.String value)
           
 IBuilderTag tagFromName(java.lang.String name)
           
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

addTag

IBuilderTag addTag(int beginIndex,
                   int endIndex,
                   java.lang.String tagName)
Parameters:
beginIndex - : the begin index of the text part to tag
endIndex - : the end index of the text part to tag
tagName - : The name of the new tag
Returns:
The tag created

addTag

IBuilderTag addTag(int beginIndex,
                   int endIndex,
                   java.lang.String tagName,
                   java.lang.String parentName)
Parameters:
beginIndex - : the begin index of the text part to tag
endIndex - : the end index of the text part to tag
tagName - : The name of the new tag
parentName - : The name of the parent tag
Returns:
The tag created

getGeneratedInfo

com.ibm.pdp.engine.IGeneratedInfo getGeneratedInfo()
Returns:
The IGeneratedInfo associated with the current IGenInfoBuilder.

getProperty

java.lang.String getProperty(java.lang.String name)
Parameters:
name - : The property name to search for
Returns:
The value of the property name

getRootTag

IBuilderTag getRootTag()
Returns:
The root IBuilderTag for the current IGenInfoBuilder

getText

java.lang.CharSequence getText()
Returns:
The entire text associated for the current IGenInfoBuilder

includingTag

IBuilderTag includingTag(int beginIndex,
                         int endIndex)
Parameters:
beginIndex - : The begin index
endIndex - : The end index
Returns:
: A tag including the 2 indexes passed in parameters. The result could be a non terminating tag, a tag including others tags...

propertyNames

java.util.Iterator<java.lang.String> propertyNames()
Returns:
An iterator which contains all the names of the properties

removeTag

void removeTag(IBuilderTag tag)
This method allow the user to remove only a tag. It only removes the tag and not the text included in and between the tags. All the children of the tag are moved to be children of the parent's tag.

Parameters:
tag - : The tag to remove

removeTag

void removeTag(java.lang.String tagName)
This method allow the user to remove a specific tag. It removes only the tag but not the content in the text.

Parameters:
tagName - : The tag name to remove

removeTagAndText

void removeTagAndText(IBuilderTag tag)
This method allow the user to remove a tag and the text in it. It removes the tag and all the text between each son. All the other children are moved to be children of the parent's tag.

Parameters:
tag - : The tag to remove

removeTree

void removeTree(IBuilderTag rootTreeTag)
This method allow the user to remove a tag and all its children, recursively. It only removes the tag and not the text included in and between the tags.

Parameters:
rootTreeTag - : The root tag to remove

removeTreeAndText

void removeTreeAndText(IBuilderTag rootTreeTag)
This method allow the user to remove a tag and all its children, recursively. It removes the tag and all the text included in and between the tags.

Parameters:
rootTreeTag - : The root tag to remove

setProperty

void setProperty(java.lang.String name,
                 java.lang.String value)
Parameters:
name - : The property name to set
value - : The value of the property name

tagFromName

IBuilderTag tagFromName(java.lang.String name)
Parameters:
name - : the name of the tag to search for
Returns:
The tag if we found it or null.