IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.config.impl
Class RefTagProvider

java.lang.Object
  extended by com.ibm.btt.config.impl.RefTagProvider
All Implemented Interfaces:
TagProvider

public class RefTagProvider
extends java.lang.Object
implements TagProvider

This feature is only used by XUI engine. Will consider about making it default behaviour of BasicElementFactory in future.


Constructor Summary
RefTagProvider(TagProvider provider)
          RefTagProvider constructor
 
Method Summary
 Tag getTag(java.lang.String id)
          find a Tag identified by the id.
 void replaceRefTag(Tag tag, TagProvider provider)
          Replace references in tag.
 void traverseSubTags(Tag tag)
          Traverse all sub tags and replace their reference
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RefTagProvider

public RefTagProvider(TagProvider provider)
RefTagProvider constructor

Parameters:
provider - wrapped tag provider
Method Detail

getTag

public Tag getTag(java.lang.String id)
           throws TagNotFoundException,
                  TagProviderException
Description copied from interface: TagProvider
find a Tag identified by the id.
the behavior of this method depends on the implementaion.
You can choose to use SimpleXMLTagProvider, as its defines all the tag in one file,
or, you can implement your own TagProvider, according to your requirments.
You should throw a TagNotFondException when the tag for id is not defined rather than return a null value.

Specified by:
getTag in interface TagProvider
Parameters:
id - id of the tag.
Returns:
corresponding tag.
Throws:
TagNotFoundException - cannot find the tag because of no definition for the id.
TagProviderException - Some error exist in TagProvider or its definition file.

traverseSubTags

public void traverseSubTags(Tag tag)
                     throws TagProviderException
Traverse all sub tags and replace their reference

Parameters:
tag - parent tag
Throws:
TagProviderException

replaceRefTag

public void replaceRefTag(Tag tag,
                          TagProvider provider)
                   throws TagProviderException
Replace references in tag.

Parameters:
tag - desired tag
provider - desired tag provider
Throws:
TagProviderException

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011