NAME

VOTABLE::DEFINITIONS - VOTABLE DEFINITIONS XML element class


SYNOPSIS

use VOTABLE::DEFINITIONS;


DESCRIPTION

This class implements the DEFINITIONS element from the VOTABLE DTD. This element is used as a glossary to store definitions used in other parts of the document.

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

 <!ELEMENT DEFINITIONS (COOSYS?, PARAM?)*>

Methods

new($xmldom_element, %options)

Create and return a new VOTABLE::DEFINITIONS 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::DEFINITIONS object. Return undef if an error occurs.

get_coosys

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

set_coosys(@votable_coosys)

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

get_param

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

set_param(@votable_param)

Set the PARAM elements for this DEFINITIONS element using the supplied list of VOTABLE::PARAM objects. Any previously existing PARAM 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::COOSYS, VOTABLE::Document, VOTABLE::PARAM


AUTHOR

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


VERSION

$Id: DEFINITIONS.pm,v 1.1.1.9 2002/05/21 14:09:19 elwinter Exp $