new($str_or_ref, %options)
get_inclusive
set_inclusive($inclusive)
get_value
set_value($value)
get
set($str)
VOTABLE::MIN - VOTABLE MIN XML element class
use VOTABLE::MIN;
This class implements the MIN
element from the VOTABLE
DTD. This
element is used to store minimum values for a numeric quantity.
The MIN
element is a Tier 0 element, and is described by the
following excerpt from the VOTABLE
1.0 DTD:
<!ELEMENT MIN (#PCDATA)> <!ATTLIST MIN value CDATA #REQUIRED inclusive (yes | no) "yes" >
new($str_or_ref, %options)
Create a new VOTABLE::MIN
object, and return a reference to it. If
the first argument ($str_or_ref
) is a string, it is used as the
initial PCDATA
content of the MIN
element. If the first argument
is a reference to a XML::DOM::Element
object, that object is used
to initialize the new MIN
element (implicitly assuming that the
XML::DOM::Element
object contains a valid MIN
element). The
%options
hash is used to set the attributes of the new element. If
the first argument is missing or undefined, or an empty string, create
and return an empty VOTABLE::MIN
object. Return undef
if an
error occurs.
get_inclusive
Return the value of the inclusive
attribute. Return undef
if the
attribute has not been set, or an error occurs.
set_inclusive($inclusive)
Set the value of the inclusive
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.
get
Return a string containing the PCDATA
content of the MIN
element. Return undef
if the element has no PCDATA
content, or
an error occurs.
set($str)
Set the PCDATA
content of the MIN
element to the specified
string. Return the string on success, or undef
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::MIN
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::VALUES
Eric Winter, NASA GSFC (elwinter@milkyway.gsfc.nasa.gov)
$Id: MIN.pm,v 1.1.1.8 2002/05/21 14:11:48 elwinter Exp $