new($xmldom_element, %options)
get_coosys
set_coosys(@votable_coosys)
get_param
set_param(@votable_param)
VOTABLE::DEFINITIONS - VOTABLE DEFINITIONS XML element class
use VOTABLE::DEFINITIONS;
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?)*>
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.
_
') are for
internal use only, and should not be used outside of the VOTABLE
class hierarchy.
get_XXX
and set_XXX
accessors for attributes
and elements are derived directly from the names of the attributes or
elements. Attribute and element names containing embedded hyphens
('-
') use accessors where the hyphen is mapped to an underscore
('_
') in the name of the accessor method. This is a necessity,
since the hyphen is not a valid name character in Perl.
VOTABLE::TABLEDATA
object always has an underlying
XML::DOM::Element
object. As long as the internal structure is
manipulated only by the publicly-available methods, this should be an
adequate assumption. If a method detects an aberrant case, a warning
message is printed (using the Carp::carp
subroutine), and the
method fails.
XML::DOM
methods always
succeed. If a method detects an aberrant case, a warning message is
printed (using the Carp::carp
subroutine), and the method fails.
set_XXX
accessors do not perform validation of the
new attribute values. The exceptions are the accessors for attributes
with enumerated values; the new value is checked against the list of
acceptable values, as defined in the DTD.
VOTABLE
, VOTABLE::COOSYS
, VOTABLE::Document
, VOTABLE::PARAM
Eric Winter, NASA GSFC (elwinter@milkyway.gsfc.nasa.gov)
$Id: DEFINITIONS.pm,v 1.1.1.9 2002/05/21 14:09:19 elwinter Exp $