edu.wisc.trace.urcsdk.client.uisocket.types
Class DecimalVariable

java.lang.Object
  edu.wisc.trace.urcsdk.client.uisocket.types.AbstractUISocketElement
      edu.wisc.trace.urcsdk.client.uisocket.types.UISocketVariable
          edu.wisc.trace.urcsdk.client.uisocket.types.NumberVariable
              edu.wisc.trace.urcsdk.client.uisocket.types.DecimalVariable

All Implemented Interfaces:

IUISocketElement, java.lang.Cloneable

public class DecimalVariable
extends NumberVariable

DecimalVariable is the number variant of UISocketVariable. It provides special handling for decimal values. It serves as the xsd:decimal type. Created on: May 25, 2006

Version:

$Revision: 1.7 $

Author:

Hemanth vijayan , Trace R&D Center

Field Summary

Fields inherited from class edu.wisc.trace.urcsdk.client.uisocket.types.UISocketVariable

dynamicValues, socketSelection

Fields inherited from class edu.wisc.trace.urcsdk.client.uisocket.types.AbstractUISocketElement

dependents, id, interactor, listeners, logger, parent, ref, secret, sensitive, session, sessionId, simpleType, socket, socketDependency, supports, timeout, type, value

Constructor Summary

DecimalVariable()
Creates a new DecimalVariable instance.

DecimalVariable(UISocketDocument parent, UISocketMirror socket, org.w3c.dom.Element rootElement)
Creates a new DecimalVariable instance.

DecimalVariable(UISocketMirror socket)
Creates a new DecimalVariable instance.

Method Summary

DecimalVariable	clone() Describe clone method here.
double	getMaxInclusive() getMaxInclusive gets the highest allowable number (inclusive)
double	getMinInclusive() getMinInclusive gets the lowest allowed number (inclusive)
double	getStep() getStep the distance between each allowed number
void	parse(org.w3c.dom.Element rootElement) Describe parse method here.
java.lang.Object	validate(java.lang.String value) checkValue determines whether a value is allowable for a given xsd type.

Methods inherited from class edu.wisc.trace.urcsdk.client.uisocket.types.UISocketVariable

addDynamicValues, getDynamicRefVars, getStaticMap, hasSelection, isClosed, isExecutable, isReadable, isWritable

Methods inherited from class edu.wisc.trace.urcsdk.client.uisocket.types.AbstractUISocketElement

checkDependencies, checkDependents, getAccessKey, getDependents, getHelp, getId, getInteractor, getKeywords, getLabel, getParent, getRef, getResource, getSecret, getSession, getSocket, getSocketDependency, getSupports, getType, getValue, getXSDSimpleType, registerDependent, registerSupport, setInteractor, setListener, setParent, setSession, setSessionId, setSocket, setValue, setValueRequest, setXSDSimpleType, toString, updateValue

Methods inherited from class java.lang.Object

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

Constructor Detail

DecimalVariable

public DecimalVariable()

Creates a new DecimalVariable instance.

DecimalVariable

public DecimalVariable(UISocketMirror socket)

Creates a new DecimalVariable instance.

Parameters:

socket - an UISocket value

DecimalVariable

public DecimalVariable(UISocketDocument parent,
                       UISocketMirror socket,
                       org.w3c.dom.Element rootElement)
                throws UrcException

Creates a new DecimalVariable instance.

Parameters:

parent - an UISocketDocument value

socket - an UISocket value

rootElement - an Element value

Throws:

UrcException - if an error occurs

Method Detail

clone

public DecimalVariable clone()

Describe clone method here.

Specified by:

clone in interface IUISocketElement

Overrides:

clone in class NumberVariable

Returns:

a DecimalVariable value

getMinInclusive

public double getMinInclusive()

getMinInclusive gets the lowest allowed number (inclusive)

Overrides:

getMinInclusive in class NumberVariable

Returns:

a double value

getMaxInclusive

public double getMaxInclusive()

getMaxInclusive gets the highest allowable number (inclusive)

Overrides:

getMaxInclusive in class NumberVariable

Returns:

a double value

parse

public void parse(org.w3c.dom.Element rootElement)
           throws UrcException

Description copied from class: UISocketVariable

Describe parse method here.

Specified by:

parse in interface IUISocketElement

Overrides:

parse in class NumberVariable

Parameters:

rootElement - an Element value

Throws:

UrcException - if an error occurs

getStep

public double getStep()

getStep the distance between each allowed number

Overrides:

getStep in class NumberVariable

Returns:

a double value

validate

public java.lang.Object validate(java.lang.String value)

Description copied from class: UISocketVariable

checkValue determines whether a value is allowable for a given xsd type. This should be overridden for every class extending UISocketVariable.

Overrides:

validate in class NumberVariable

Parameters:

value -

Returns:

the decimal value if it's valid else null