|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.dse.base.DataElement | +--com.ibm.dse.base.DataField | +--com.ibm.dse.application.CounterElement
The CounterElement class derives from DataField.
It can be a total, an increment, or a totIncrs. It has four properties :
Fields inherited from class com.ibm.dse.base.DataField |
value |
Fields inherited from class com.ibm.dse.base.DataElement |
description,
name,
state |
Constructor Summary | |
CounterElement()
This constructor creates the CounterElement object. |
|
CounterElement(java.lang.String aName)
This constructor creates a new instance of the CounterElement class, which is obtained from the SGML definition files through aName). |
Method Summary | |
java.lang.Boolean |
getCheckIfRequired()
Gets the checkIfRequired property (java.lang.Boolean) value. |
java.lang.Float |
getMaxLimit()
Gets the maxLimit property (java.lang.Float) value. |
java.lang.Float |
getMinLimit()
Gets the minLimit property (java.lang.Float) value. |
Counter |
getParentCounter()
Gets the parentCounter property (Counters.Counter) value. |
java.lang.Object |
getValue()
Gets the value property (java.lang.Object) value. |
java.lang.Object |
initializeFrom(Tag aTag)
Returns the counterElement implemented by the Tag aTag. |
void |
setCheckIfRequired(java.lang.Boolean pCheckIfRequired)
Sets the checkIfRequired property (java.lang.Boolean) value. |
void |
setMaxLimit(java.lang.Float pMaxLimit)
Sets the maxLimit property (java.lang.Float) value. |
void |
setMinLimit(java.lang.Float pMinLimit)
Sets the minLimit property (java.lang.Float) value. |
void |
setParentCounter(Counter pParentCounter)
Sets the parentCounter property (Counters.Counter) value. |
java.lang.String |
toString()
Returns a String representation of the counterElement. |
void |
tryMaxLimit(java.lang.Float aMax)
Tests if the maxLimit aMax could be a correct maxLimit for the CounterElement. |
void |
tryMinLimit(java.lang.Float aMin)
Tests if the MinLimit aMin is a correct minLimit for the CounterElement. |
void |
tryValue(java.lang.Float aValue)
Tests if the value aValue is a correct value for the CounterElement. |
Methods inherited from class com.ibm.dse.base.DataField |
clone,
nestedElements,
nestedElements,
nestedFields,
readExternal,
setValidValue,
setValidValue,
setValidValue,
setValidValue,
setValidValue,
setValidValue,
setValidValue,
setValidValue,
setValue,
setValue,
setValue,
setValue,
setValue,
setValue,
setValue,
setValue,
validate,
validateState,
writeExternal |
Methods inherited from class com.ibm.dse.base.DataElement |
externalizer,
getDescription,
getDescriptor,
getElementAt,
getErrorInfo,
getExternalizer,
getKey,
getName,
getState,
getTagName,
readExternal,
readObject,
removeElementAt,
removeExternal,
setDescription,
setDescriptor,
setErrorInfo,
setExternalizer,
setName,
setState,
toStrings,
toTags,
writeExternal |
Methods inherited from class java.lang.Object |
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Constructor Detail |
public CounterElement()
public CounterElement(java.lang.String aName) throws java.io.IOException
Method Detail |
public java.lang.Boolean getCheckIfRequired()
public java.lang.Float getMaxLimit()
public java.lang.Float getMinLimit()
public Counter getParentCounter()
public java.lang.Object getValue()
The default value for any counterElement is a null Float.
DataField.setValue(byte)
public java.lang.Object initializeFrom(Tag aTag) throws java.io.IOException
This method throws an IOException if the externalizer hasn't been initialized.
aTag
- Tagpublic void setCheckIfRequired(java.lang.Boolean pCheckIfRequired)
public void setMaxLimit(java.lang.Float pMaxLimit)
public void setMinLimit(java.lang.Float pMinLimit)
public void setParentCounter(Counter pParentCounter)
public java.lang.String toString()
public void tryMaxLimit(java.lang.Float aMax) throws DSECounterException
Otherwise it throws a DSECounterException with "MaxOverValue" code.
public void tryMinLimit(java.lang.Float aMin) throws DSECounterException
If it is not a correct minLimit, it throws a DSECounterException with "MinUnderValue" code.
public void tryValue(java.lang.Float aValue) throws DSECounterException
If it is not a correct value for the CounterElement, it throws a DSECounterException with "ValueOverMax" or "ValueUnderMin" code, depending on which limit was passed.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |