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
Class RenderingRule

java.lang.Object
  extended by com.ibm.hats.transform.RenderingRule
All Implemented Interfaces:
IRenderingRule, Cloneable

public class RenderingRule
extends Object
implements Cloneable, IRenderingRule

RenderingRule is a class representing the configuration of a global rule. It contains a reference to a PatternComponent along with its configuration settings, enablement, associated screen capture, and associated transformation fragment. RenderingRules are stored in a RenderingRuleSet, which is the format by which they are supplied to the RenderingRulesEngine upon construction.

This class does not need to be used directly by custom Component or Widget developers.

See Also:
RenderingRulesEngine, RenderingRuleSet

Field Summary
static String ATTR_TRANFORMATION_FRAGMENT
          Transformation Fragment attribute name for a rule element.
static String TAG_RULE
          XML tag name for a rule element.
 
Fields inherited from interface com.ibm.hats.transform.IRenderingRule
COPYRIGHT
 
Constructor Summary
RenderingRule(Element item)
          Class contructor for a RenderingRule from a DOM Element.
RenderingRule(String name, String componentClassName, BlockScreenRegion region, Properties componentSettings, String transformationFragment)
          RenderingRule constructor.
 
Method Summary
 Object clone()
           
 String getAssociatedScreen()
          Gets the name of the associated screen capture.
 String getComponentClassName()
          Gets the name of the PatternComponent for this rule.
 Properties getComponentSettings()
          Gets the settings for the PatternComponent in this rule.
 String getDescription()
          Gets the description.
 String getName()
          Gets the name of this rule.
 BlockScreenRegion getRegion()
          Not currently used.
 String getTransformationFragment()
          Gets the name of the associated transformation fragment for this rule.
 boolean isEnabled()
          Gets whether or not this rule is enabled.
 void setAssociatedScreen(String string)
          Sets the name of the associated screen capture.
 void setComponentClassName(String string)
          Sets the name of the PatternComponent for this rule.
 void setComponentSettings(Properties properties)
          Sets the settings for the PatternComponent in this rule.
 void setDescription(String string)
          Sets the description.
 void setEnabled(boolean b)
          Sets whether or not this rule is enabled.
 void setName(String string)
          Sets the name of this rule.
 void setRegion(BlockScreenRegion region)
          Not currently used.
 void setTransformationFragment(String string)
          Sets the name of the associated transformation fragment for this rule.
 Element toElement(Document doc)
          Serialize this rule to a DOM document.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TAG_RULE

public static final String TAG_RULE
XML tag name for a rule element.

See Also:
Constant Field Values

ATTR_TRANFORMATION_FRAGMENT

public static final String ATTR_TRANFORMATION_FRAGMENT
Transformation Fragment attribute name for a rule element.

See Also:
Constant Field Values
Constructor Detail

RenderingRule

public RenderingRule(String name,
                     String componentClassName,
                     BlockScreenRegion region,
                     Properties componentSettings,
                     String transformationFragment)
RenderingRule constructor.

Parameters:
name -
componentClassName -
region - not currently used
componentSettings -
transformationFragment -

RenderingRule

public RenderingRule(Element item)
Class contructor for a RenderingRule from a DOM Element.

Parameters:
item -
Method Detail

clone

public Object clone()
Overrides:
clone in class Object

getAssociatedScreen

public String getAssociatedScreen()
Gets the name of the associated screen capture.

Specified by:
getAssociatedScreen in interface IRenderingRule
Returns:
The name of the associated screen capture.

getDescription

public String getDescription()
Gets the description.

Specified by:
getDescription in interface IRenderingRule
Returns:
The description.

getRegion

public BlockScreenRegion getRegion()
Not currently used.

Specified by:
getRegion in interface IRenderingRule
Returns:
The block screen region.

setAssociatedScreen

public void setAssociatedScreen(String string)
Sets the name of the associated screen capture.

Parameters:
string - The name of the assoicated screen capture.

setDescription

public void setDescription(String string)
Sets the description.

Parameters:
string - The description.

setRegion

public void setRegion(BlockScreenRegion region)
Not currently used.

Parameters:
region - The block screen region.

isEnabled

public boolean isEnabled()
Gets whether or not this rule is enabled.

Specified by:
isEnabled in interface IRenderingRule
Returns:
Returns true if this rule is enabled, false otherwise.

setEnabled

public void setEnabled(boolean b)
Sets whether or not this rule is enabled.

Parameters:
b - A boolean value indicating whether or not this rule is enabled.

getTransformationFragment

public String getTransformationFragment()
Gets the name of the associated transformation fragment for this rule.

Specified by:
getTransformationFragment in interface IRenderingRule
Returns:
The name of the associated transformation fragment for this rule.

setTransformationFragment

public void setTransformationFragment(String string)
Sets the name of the associated transformation fragment for this rule.

Parameters:
string - The name of the associated transformation fragment for this rule.

toElement

public Element toElement(Document doc)
Serialize this rule to a DOM document.

Parameters:
doc - The document to append to.
Returns:
element The element representing this rule.

getComponentClassName

public String getComponentClassName()
Gets the name of the PatternComponent for this rule.

Specified by:
getComponentClassName in interface IRenderingRule
Returns:
The name of the PatternComponent for this rule.

setComponentClassName

public void setComponentClassName(String string)
Sets the name of the PatternComponent for this rule.

Parameters:
string - The name of the PatternComponent for this rule.

getComponentSettings

public Properties getComponentSettings()
Gets the settings for the PatternComponent in this rule.

Specified by:
getComponentSettings in interface IRenderingRule
Returns:
The settings for the PatternComponent in this rule.

setComponentSettings

public void setComponentSettings(Properties properties)
Sets the settings for the PatternComponent in this rule.

Parameters:
properties - The settings for the PatternComponent in this rule.

getName

public String getName()
Gets the name of this rule.

Specified by:
getName in interface IRenderingRule
Returns:
The name of this rule.

setName

public void setName(String string)
Sets the name of this rule.

Parameters:
string - The name of this rule.

HATS 7.5.1 (201005110649)