uk.ac.starlink.votable
Class ValuesElement

java.lang.Object
  |
  +--uk.ac.starlink.votable.VOElement
        |
        +--uk.ac.starlink.votable.ValuesElement

public class ValuesElement
extends VOElement

Field or Param value restriction set represented by a VALUES element in a VOTable.


Constructor Summary
ValuesElement(Element el, String systemId)
          Constructs a ValuesElement object from a VALUES element.
 
Method Summary
 String getMaximum()
          Returns the specified maximum value for this ValuesElement object (the value of any Maximum child).
 String getMinimum()
          Returns the specified minimum value for this ValuesElement object (the value of any MINIMUM child).
 String getNull()
          Returns the 'null' value for this ValuesElement object, that is the value which represents an undefined data value.
 String[] getOptions()
          Returns the specified option values for this ValuesElement object.
 String getType()
          Returns the supplied or implied value of the 'type' attribute of this ValuesElement object.
 boolean isInvalid()
          Returns the sense of the supplied or implied 'invalid' attribute of this ValuesElement object.
 
Methods inherited from class uk.ac.starlink.votable.VOElement
equals, getAttribute, getAttribute, getChildByName, getChildren, getChildrenByName, getContext, getDescendantsByName, getDescription, getElement, getHandle, getID, getName, getParent, getSource, getSystemId, getTagName, getTextContent, hasAttribute, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ValuesElement

public ValuesElement(Element el,
                     String systemId)
Constructs a ValuesElement object from a VALUES element.

Parameters:
el - a VALUES element
systemId - document system ID
Method Detail

getMaximum

public String getMaximum()
Returns the specified maximum value for this ValuesElement object (the value of any Maximum child).

Returns:
maximum value, or null if none specified

getMinimum

public String getMinimum()
Returns the specified minimum value for this ValuesElement object (the value of any MINIMUM child).

Returns:
minimum value, or null if none specified

getOptions

public String[] getOptions()
Returns the specified option values for this ValuesElement object.

Returns:
an array of option strings ('value' attributes of OPTION children)

getNull

public String getNull()
Returns the 'null' value for this ValuesElement object, that is the value which represents an undefined data value. This is the value of the 'null' attribute of the VALUES element, but does not have anything to do with the Java language null value.

Returns:
the 'null' value for this ValuesElement object or, confusingly, null if none is defined

getType

public String getType()
Returns the supplied or implied value of the 'type' attribute of this ValuesElement object.

Returns:
one of the strings 'actual' or 'legal'

isInvalid

public boolean isInvalid()
Returns the sense of the supplied or implied 'invalid' attribute of this ValuesElement object. I don't know what the semantics of this is supposed to be though, I can't find it referenced in the VOTable document.

Returns:
is the 'invalid' attribute present and equal to "yes"?

Copyright © 2004 CLRC: Central Laboratory of the Research Councils. All rights reserved.