NAME

VOTABLE::FIELD - VOTABLE FIELD XML element class


SYNOPSIS

use VOTABLE::FIELD;


DESCRIPTION

This class implements the FIELD element from the VOTABLE DTD. This class stores metadata for a single field (column) in a table.

The FIELD element is a Tier 3 element, and is described by the following excerpt from the VOTABLE 1.0 DTD:

 <!ELEMENT FIELD (DESCRIPTION?, VALUES*, LINK*)>
 <!ATTLIST FIELD
         ID ID #IMPLIED
         unit CDATA #IMPLIED
         datatype (boolean | bit | unsignedByte | short | int | long | char
        | unicodeChar | float | double | floatComplex | doubleComplex) #IMPLIED
         precision CDATA #IMPLIED
         width CDATA #IMPLIED
         ref IDREF #IMPLIED
         name CDATA #IMPLIED
         ucd CDATA #IMPLIED
         arraysize CDATA #IMPLIED
         type (hidden | no_query | trigger) #IMPLIED
 >

Methods

new($xmldom_element, %options)

Create and return a new VOTABLE::FIELD object, based on the supplied XML::DOM::Element object, using %options to set the attributes of the new object. If no XML::DOM::Element object is specified, or is undefined, create and return an empty VOTABLE::FIELD object. Return undef if an error occurs.

get_ID

Return the value of the ID attribute. Return undef if the attribute has not been set, or an error occurs.

set_ID($id)

Set the value of the ID attribute to the specified value. Return the new value of the attribute on success, or undef if an error occurs.

get_arraysize

Return the value of the arraysize attribute. Return undef if the attribute has not been set, or an error occurs.

set_arraysize($arraysize)

Set the value of the arraysize attribute to the specified value. Return the new value of the attribute on success, or undef if an error occurs.

get_datatype

Return the value of the datatype attribute. Return undef if the attribute has not been set, or an error occurs.

set_datatype($datatype)

Set the value of the datatype attribute to the specified value. Return the new value of the attribute on success, or undef if an error occurs.

get_name

Return the value of the name attribute. Return undef if the attribute has not been set, or an error occurs.

set_name($name)

Set the value of the name attribute to the specified value. Return the new value of the attribute on success, or undef if an error occurs.

get_precision

Return the value of the precision attribute. Return undef if the attribute has not been set, or an error occurs.

set_precision($precision)

Set the value of the precision attribute to the specified value. Return the new value of the attribute on success, or undef if an error occurs.

get_ref

Return the value of the ref attribute. Return undef if the attribute has not been set, or an error occurs.

set_ref($ref)

Set the value of the ref attribute to the specified value. Return the new value of the attribute on success, or undef if an error occurs.

get_type

Return the value of the type attribute. Return undef if the attribute has not been set, or an error occurs.

set_type($type)

Set the value of the type attribute to the specified value. Return the new value of the attribute on success, or undef if an error occurs.

get_ucd

Return the value of the ucd attribute. Return undef if the attribute has not been set, or an error occurs.

set_ucd($ucd)

Set the value of the ucd attribute to the specified value. Return the new value of the attribute on success, or undef if an error occurs.

get_unit

Return the value of the unit attribute. Return undef if the attribute has not been set, or an error occurs.

set_unit($unit)

Set the value of the unit attribute to the specified value. Return the new value of the attribute on success, or undef if an error occurs.

get_width

Return the value of the width attribute. Return undef if the attribute has not been set, or an error occurs.

set_width($width)

Set the value of the width attribute to the specified value. Return the new value of the attribute on success, or undef if an error occurs.

get_description

Return the VOTABLE::DESCRIPTION object for the DESCRIPTION element of this FIELD element. Return undef If no DESCRIPTION element is found, or an error occurs.

set_description($votable_description)

Set the DESCRIPTION element for this FIELD element to the supplied VOTABLE::DESCRIPTION object. Return the VOTABLE::DESCRIPTION object on success, or undef if an error occurs.

get_link

Return a list of the VOTABLE::LINK objects for the LINK elements which are the children of this FIELD element. Return an empty list if no LINK elements are found, or if an error occurs.

set_link(@votable_link)

Set the LINK elements for this FIELD element using the supplied list of VOTABLE::LINK objects. Any previously existing LINK elements are first removed. Return the input list on success, or an empty list if an error occurs.

get_values

Return a list of the VOTABLE::VALUES objects for the VALUES elements which are the children of this FIELD element. Return an empty list if no VALUES elements are found, or if an error occurs.

set_values(@votable_values)

Set the VALUES elements for this FIELD element using the supplied list of VOTABLE::VALUES objects. Any previously existing VALUES elements are first removed. Return the input list on success, or an empty list if an error occurs.

Notes on class internals


WARNINGS


SEE ALSO

VOTABLE, VOTABLE::DESCRIPTION, VOTABLE::LINK, VOTABLE::TABLE, VOTABLE::VALUES


AUTHOR

Eric Winter, NASA GSFC (elwinter@milkyway.gsfc.nasa.gov)


VERSION

$Id: FIELD.pm,v 1.1.1.8 2002/05/21 14:10:33 elwinter Exp $