ilog.rules.ras.core.kpi
Class IlrBaseKpiObject

java.lang.Object
  ilog.rules.ras.core.kpi.IlrBaseKpiObject

All Implemented Interfaces:

IlrKpiObject, Serializable

Direct Known Subclasses:

IlrKpiOnErrorKpiObject, IlrStringKpi

public abstract class IlrBaseKpiObject
extends Object
implements IlrKpiObject

A base KPI result class that facilitates the XML serialization and deserialization of the KPI object.

See Also:

Serialized Form

Constructor Summary

IlrBaseKpiObject()
Creates an IlrBaseKpiObject instance.

Method Summary

void	fromXml(com.thoughtworks.xstream.io.HierarchicalStreamReader hsr) Deserializes the object from XML.
String	getDisplay() Gets the string to display in reports which are not HTML based.
String	getHtml() Serializes the result to HTML for display in HTML reports and in the web interface.
Object	getObject() Gets the data object represented by this KPI.
void	setObject(Object oo) Sets the data object represented by this KPI.
void	toXml(com.thoughtworks.xstream.io.HierarchicalStreamWriter hsw) Serializes the object to XML.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlrBaseKpiObject

public IlrBaseKpiObject()

Creates an IlrBaseKpiObject instance.

Method Detail

setObject

public void setObject(Object oo)

Description copied from interface: IlrKpiObject

Sets the data object represented by this KPI.

Specified by:

setObject in interface IlrKpiObject

Parameters:

oo - The data object represented by this KPI.

getObject

public Object getObject()

Description copied from interface: IlrKpiObject

Gets the data object represented by this KPI.

Specified by:

getObject in interface IlrKpiObject

Returns:

The data object represented by this KPI.

getDisplay

public String getDisplay()

Description copied from interface: IlrKpiObject

Gets the string to display in reports which are not HTML based.

Specified by:

getDisplay in interface IlrKpiObject

Returns:

The string to display in all reports to summarize this KPI object.

getHtml

public String getHtml()

Description copied from interface: IlrKpiObject

Serializes the result to HTML for display in HTML reports and in the web interface.

Specified by:

getHtml in interface IlrKpiObject

Returns:

A string of HTML to be inserted into an HTML report.

toXml

public void toXml(com.thoughtworks.xstream.io.HierarchicalStreamWriter hsw)

Description copied from interface: IlrKpiObject

Serializes the object to XML.

Specified by:

toXml in interface IlrKpiObject

Parameters:

hsw - The writer.

fromXml

public void fromXml(com.thoughtworks.xstream.io.HierarchicalStreamReader hsr)

Description copied from interface: IlrKpiObject

Deserializes the object from XML.

Specified by:

fromXml in interface IlrKpiObject

Parameters:

hsr - The reader.