NAME

VOTABLE::OPTION - VOTABLE OPTION XML element class


SYNOPSIS

use VOTABLE::OPTION;


DESCRIPTION

This class implements the OPTION element from the VOTABLE DTD. This element is used to enumerate multiple possible values for an item.

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

 <!ELEMENT OPTION (OPTION*)>
 <!ATTLIST OPTION
         name CDATA #IMPLIED
         value CDATA #REQUIRED
 >

Methods

new($xmldom_element, %options)

Create and return a new VOTABLE::OPTION 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::OPTION object. Return 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_value

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

set_value($value)

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

Notes on class internals


WARNINGS


SEE ALSO

VOTABLE, VOTABLE::VALUES


AUTHOR

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


VERSION

$Id: OPTION.pm,v 1.1.1.8 2002/05/21 14:12:00 elwinter Exp $