Package COM.TIBCO.hawk.config.rbengine

Class RBEConfigObjectAttributes

java.lang.Object
COM.TIBCO.hawk.config.rbengine.RBEConfigObjectAttributes
All Implemented Interfaces:
Cloneable
Direct Known Subclasses:
Attributes, Attributes
public abstract class RBEConfigObjectAttributes extends Object implements Cloneable
This RBEConfigObjectAttributes contains basic attributes of a rulebase configuration objects such as Rulebase, Schedules, or RBMap. It includes author, last Modification and comment.

When a rulebase configuration object is created, the author and last modification attributes should be set. These two attributes should also be updated when the rulebase configuration object is changed.

When comparing rulebase configuration objects, these attributes are not taken into consideration. For example, two schedules having identical list of schedules but have different comments and last modification are consider equal.

See Also:

  • Constructor Details

    • RBEConfigObjectAttributes

      protected RBEConfigObjectAttributes()
      Constructor.

    • RBEConfigObjectAttributes

      protected RBEConfigObjectAttributes(COM.TIBCO.hawk.util.xml.XmlElementNode node) throws RBEConfigObjectException
      Constructor. From XML node
      Throws:
      RBEConfigObjectException

  • Method Details

    • setAuthor

      public void setAuthor(String name)
      Sets the author this rulebase configuration object.

    • setLastModification

      public void setLastModification(String timeStamp)
      Sets the last modification record this rulebase configuration object. The record should indicate who and when the change is being made. The method constructChangedStamp is provided to create such a record.

      See Also:

    • setComment

      public void setComment(String name)
      Sets the comment of this rulebase configuration object.

    • getAuthor

      public String getAuthor()
      Returns the author of this rulebase configuration object.

    • getLastModification

      public String getLastModification()
      Returns the last modification record of this rulebase configuration object.

    • getComment

      public String getComment()
      Returns the comment of this rulebase configuration object. The comment attribute is used to record user comments about the purpose of the rulebase configuration object. It also may serve as a place to record the rulebase configuration object change history.

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone a copy of this object
      Overrides:
      clone in class Object
      Returns:
      a copy of this object
      Throws:
      CloneNotSupportedException

    • constructChangedStamp

      public static String constructChangedStamp()
      A convenient method to create a time stampt for setting last modification record. The format of the output string is as follow: 
       userName on host hostName at HH:mm EE, MMM d, yyyy
      where userName is from the system properry user.name, and hostName is the name from the machine where the JVM is running.

      Returns:
      a useful string for last modification record.

    • getNodeValue

      protected String getNodeValue(Node node)

    • copy

      protected void copy(RBEConfigObjectAttributes toCopy)

    • writeAttributes

      protected void writeAttributes(COM.TIBCO.hawk.util.xml.XmlWriter out) throws IOException, RBEConfigObjectException
      Throws:
      IOException
      RBEConfigObjectException

    • readAttributes

      protected void readAttributes(COM.TIBCO.hawk.util.xml.XmlElementNode node) throws RBEConfigObjectException
      Throws:
      RBEConfigObjectException

    • toXML

      protected void toXML(COM.TIBCO.hawk.util.xml.XmlWriter out) throws IOException, RBEConfigObjectException
      Throws:
      IOException
      RBEConfigObjectException

    • fromXML

      protected void fromXML(COM.TIBCO.hawk.util.xml.XmlElementNode documentNode) throws RBEConfigObjectException
      Throws:
      RBEConfigObjectException