|
|||||||||
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.DataCollection | +--com.ibm.dse.base.KeyedCollection | +--com.ibm.dse.application.Counter
The Counter class derives from KeyedCollection.
It holds three CounterElements :
Fields inherited from class com.ibm.dse.base.DataElement |
description,
name,
state |
Constructor Summary | |
Counter()
This constructor creates a Counter object. |
|
Counter(java.lang.String aName)
This constructor creates a new instance of the Counter class, which is obtained from the external definition files through aName. |
Method Summary | |
void |
add(CounterElement aCounterElement)
Adds a CounterElement to the counter. |
java.lang.Boolean |
getCheckIfRequired()
Returns the checkIfRequired property. |
java.lang.Float |
getIncrement()
Returns the Increment value. |
java.lang.Float |
getIncrementMaxLimit()
Returns the MaxLimit property of Increment CounterElement. |
java.lang.Float |
getIncrementMinLimit()
Returns the MinLimit property of Increment CounterElement. |
java.lang.Float |
getTotal()
Returns the Total value. |
java.lang.Float |
getTotalMaxLimit()
Returns the MaxLimit property of Total CounterElement. |
java.lang.Float |
getTotalMinLimit()
Returns the MinLimit property of Total CounterElement. |
java.lang.Float |
getTotIncrs()
Returns the TotIncrs value. |
java.lang.Float |
getTotIncrsMaxLimit()
Returns the MaxLimit property of TotIncrs CounterElement. |
java.lang.Float |
getTotIncrsMinLimit()
Returns the MinLimit property of TotIncrs CounterElement. |
java.lang.Object |
getValueAt(java.lang.String aName)
Returns the value of the CounterElement specified by aName. |
java.lang.Object |
initializeFrom(Tag aTag)
Returns the counter implemented by the Tag aTag. |
void |
setCheckIfRequired(java.lang.Boolean aBoolean)
Sets the CheckIfRequired property of the increment CounterElement. |
CounterElement |
setIncrement(java.lang.Float aFloat)
Sets Increment value. |
void |
setIncrementMaxLimit(java.lang.Float aFloat)
Sets the MaxLimit property of Increment. |
void |
setIncrementMinLimit(java.lang.Float aFloat)
Sets the MinLimit property of Increment. |
CounterElement |
setTotal(java.lang.Float aFloat)
Sets the value of Total. |
void |
setTotalMaxLimit(java.lang.Float aFloat)
Sets the maxLimit property of Total. |
void |
setTotalMinLimit(java.lang.Float aFloat)
Sets the minLimit property of Total. |
CounterElement |
setTotIncrs(java.lang.Float aFloat)
Sets the value of TotIncrs. |
void |
setTotIncrsMaxLimit(java.lang.Float aFloat)
Sets the maxLimit property of TotIncrs. |
void |
setTotIncrsMinLimit(java.lang.Float aFloat)
Sets the minLimit property of TotIncrs. |
void |
setValueAt(java.lang.String aName,
java.lang.Object aValue)
Sets the value aValue as the value of the CounterElement named aName. |
Vector |
toStrings()
Returns a Vector with a String representation of the counter. |
Methods inherited from class com.ibm.dse.base.KeyedCollection |
addElement,
addElement,
calculeNestedElements,
calculeNestedQualifiedElements,
clone,
getDynamic,
getElementAt,
getElementAt,
getElementAtAnyLevel,
getElementAtFirstLevel,
getElements,
getEnumeration,
getIndexOf,
getIndexOf,
getNestedElements,
getOrder,
getValue,
isDynamic,
readExternal,
removeAll,
removeElementAt,
removeElementAt,
removeElementAtFirstLevel,
reorderElements,
setDynamic,
setElements,
setOrder,
setValue,
setValueAt,
size,
toString,
validate,
writeExternal |
Methods inherited from class com.ibm.dse.base.DataCollection |
nestedElements,
nestedElements,
nestedFields,
nestedKeyedCollections,
nestedQualifiedElements |
Methods inherited from class com.ibm.dse.base.DataElement |
externalizer,
getDescription,
getDescriptor,
getErrorInfo,
getExternalizer,
getKey,
getName,
getState,
getTagName,
readExternal,
readObject,
removeExternal,
setDescription,
setDescriptor,
setErrorInfo,
setExternalizer,
setName,
setState,
toTags,
writeExternal |
Methods inherited from class java.lang.Object |
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Constructor Detail |
public Counter()
public Counter(java.lang.String aName) throws java.io.IOException
Method Detail |
public void add(CounterElement aCounterElement)
public java.lang.Boolean getCheckIfRequired() throws DSEObjectNotFoundException
This method throws a DSEObjectNotFoundException if the "increment" counterElement is not found.
public java.lang.Float getIncrement() throws DSEObjectNotFoundException
This method throws a DSEObjectNotFoundException if the "increment" counterElement is not found.
public java.lang.Float getIncrementMaxLimit() throws DSEObjectNotFoundException
This method throws a DSEObjectNotFoundException if the "increment" counterElement is not found.
public java.lang.Float getIncrementMinLimit() throws DSEObjectNotFoundException
This method throws a DSEObjectNotFoundException if the "increment" counterElement is not found.
public java.lang.Float getTotal() throws DSEObjectNotFoundException
This method throws a DSEObjectNotFoundException if the "total" counterElement is not found.
public java.lang.Float getTotalMaxLimit() throws DSEObjectNotFoundException
This method throws a DSEObjectNotFoundException if the "total" counterElement is not found.
public java.lang.Float getTotalMinLimit() throws DSEObjectNotFoundException
This method throws a DSEObjectNotFoundException if the "total" counterElement is not found.
public java.lang.Float getTotIncrs() throws DSEObjectNotFoundException
This method throws a DSEObjectNotFoundException if the "totIncrs" counterElement is not found.
public java.lang.Float getTotIncrsMaxLimit() throws DSEObjectNotFoundException
This method throws a DSEObjectNotFoundException if the "totIncrs" counterElement is not found.
public java.lang.Float getTotIncrsMinLimit() throws DSEObjectNotFoundException
This method throws a DSEObjectNotFoundException if the "totIncrs" counterElement is not found.
public java.lang.Object getValueAt(java.lang.String aName) throws DSEObjectNotFoundException
This method throws a DSEObjectNotFoundException if the aName counterElement is not found.
aCompositeKey
- java.lang.Stringpublic 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 aBoolean) throws DSEObjectNotFoundException
This method throws a DSEObjectNotFoundException if the "increment" counterElement is not found.
public CounterElement setIncrement(java.lang.Float aFloat) throws DSECounterException, DSEObjectNotFoundException, DSEInvalidArgumentException
It first tests if the value is correct then, if the value is correct, it sets it.
This method throws :
public void setIncrementMaxLimit(java.lang.Float aFloat) throws DSECounterException, DSEObjectNotFoundException
It first tests if the maxLimit value is correct then, if the maxLimit value is correct, it sets it.
This method throws :
public void setIncrementMinLimit(java.lang.Float aFloat) throws DSECounterException, DSEObjectNotFoundException
It first tests if the minLimit value is correct then, if the minLimit value is correct, it sets it.
This method throws :
public CounterElement setTotal(java.lang.Float aFloat) throws DSECounterException, DSEObjectNotFoundException, DSEInvalidArgumentException
It first tests if the value is correct then, if the value is correct, it sets it.
This method throws :
public void setTotalMaxLimit(java.lang.Float aFloat) throws DSECounterException, DSEObjectNotFoundException
It first tests if the maxLimit value is correct then, if the maxLimit value is correct, it sets it.
This method throws :
public void setTotalMinLimit(java.lang.Float aFloat) throws DSECounterException, DSEObjectNotFoundException
It first tests if the minLimit value is correct then, if the minLimit value is correct, it sets it.
This method throws :
public CounterElement setTotIncrs(java.lang.Float aFloat) throws DSECounterException, DSEObjectNotFoundException, DSEInvalidArgumentException
It first tests if the value is correct then, if the value is correct, it sets it.
This method throws :
public void setTotIncrsMaxLimit(java.lang.Float aFloat) throws DSECounterException, DSEObjectNotFoundException
It first tests if the maxLimit value is correct then, if the maxLimit value is correct, it sets it.
This method throws :
public void setTotIncrsMinLimit(java.lang.Float aFloat) throws DSECounterException, DSEObjectNotFoundException
It first tests if the minLimit value is correct then, if the minLimit value is correct, it sets it.
This method throws :
public void setValueAt(java.lang.String aName, java.lang.Object aValue) throws DSEObjectNotFoundException, DSEInvalidArgumentException
If the CounterElement that is set is the increment, it sets the new Total and TotIncrs Values.
The value aValue that is passed is considered correct and the set is always allowed.
This method throws :
aName
- java.lang.StringaKeyedCollection
- KeyedCollectionaType
- java.lang.Stringpublic Vector toStrings()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |