HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.transform
Interface IRenderingRulesEngine

All Known Implementing Classes:
com.ibm.hats.transform.AbstractRenderingRulesEngine, RenderingRulesEngine

public interface IRenderingRulesEngine


Field Summary
static String COPYRIGHT
          The HsrCopyright.COPYRIGHT field will be updated each release, thereby "magically" updating this class file.
 
Method Summary
 PatternMatchComponentElement getMatchingComponentElement(ComponentElement ce)
          Convenience method for grabbing the PatternMatchComponentElement from the MatchingElement for the specified ComponentElement
 com.ibm.hats.transform.MatchingElement getMatchingElement(ComponentElement ce)
          Gets a MatchingElement which corresponds to the specified ComponentElement.
 IRenderingRule getMatchingRenderingRule(ComponentElement ce)
          Gets the IRenderingRule that is responsible for transforming the specified component element.
 int getNumElementsFound()
          Returns the number of matches that were found.
 String processPatternMatchElement(com.ibm.hats.transform.MatchingElement me, ContextAttributes contextAttributes)
          Attempts to see if a given ComponentElement was matched by any rendering rules, and if so, return the fragment content as a string.
 

Field Detail

COPYRIGHT

static final String COPYRIGHT
The HsrCopyright.COPYRIGHT field will be updated each release, thereby "magically" updating this class file.

See Also:
Constant Field Values
Method Detail

getMatchingComponentElement

PatternMatchComponentElement getMatchingComponentElement(ComponentElement ce)
Convenience method for grabbing the PatternMatchComponentElement from the MatchingElement for the specified ComponentElement

Parameters:
ce - ComponentElement to match on
Returns:
PatternMatchComponentElement corresponding to this ComponentElement

getMatchingElement

com.ibm.hats.transform.MatchingElement getMatchingElement(ComponentElement ce)
Gets a MatchingElement which corresponds to the specified ComponentElement.

Parameters:
ce - ComponentElement to search for matches on
Returns:
a MatchingElement which corresponds to the specified ComponentElement, or null if none exists

getMatchingRenderingRule

IRenderingRule getMatchingRenderingRule(ComponentElement ce)
Gets the IRenderingRule that is responsible for transforming the specified component element.

Parameters:
ce -
Returns:
An instance of the matching IRenderingRule.

processPatternMatchElement

String processPatternMatchElement(com.ibm.hats.transform.MatchingElement me,
                                  ContextAttributes contextAttributes)
Attempts to see if a given ComponentElement was matched by any rendering rules, and if so, return the fragment content as a string. This method must be overridden by its consumer in order for Widgets to exploit global rules.

Parameters:
me - matching element to match against
contextAttributes - context attribute information (see class ContextAttributes for more detail)
Returns:
content from the Transformation Fragment

getNumElementsFound

int getNumElementsFound()
Returns the number of matches that were found.

Returns:
The number of matches found.

HATS 7.5.1 (201005110649)