COM.TIBCO.hawk.config.rbengine

Interface RBEConfigObject

All Known Implementing Classes:

RBMap, Rulebase, Schedules

public interface RBEConfigObject

This interface provides the facilities required to save RuleBaseEngine configuration objects to files. It provides methods to compute the file name as well as a method to produce an XML representation of the object.

By convention, all classes that implement this interface should include a constructor that allows instances to be recreated from a Reader containing an XML representation produced by the toXML() method.

Method Summary

Modifier and Type	Method and Description
long	getChecksum() Returns the checksum of the configuration object
java.lang.String	getFileExtension() Returns file extension based on the configuration object type.
java.lang.String	getName() Returns the name for this RuleBaseEngine configuration object.
void	toXML(java.io.Writer writer) Write the configuration object to the writer in XML.

Method Detail

getName

java.lang.String getName()

Returns the name for this RuleBaseEngine configuration object.

This name, together with the file extention returned by getFileExtention(), should be used as the file name if this object is saved to a file.

getFileExtension

java.lang.String getFileExtension()

Returns file extension based on the configuration object type.

Returns:

the file extension of the configuration object

toXML

void toXML(java.io.Writer writer)
    throws RBEConfigObjectException

Write the configuration object to the writer in XML.

Throws:

RBEConfigObjectException

getChecksum

long getChecksum()

Returns the checksum of the configuration object