NAME

VOTABLE::STREAM - VOTABLE STREAM XML element class


SYNOPSIS

use VOTABLE::STREAM;


DESCRIPTION

This class implements the STREAM element from the VOTABLE DTD. This element is used to encapsulate streams of arbitrary data, possible encoded and/or compressed.

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

 <!ELEMENT STREAM (#PCDATA)>
 <!ATTLIST STREAM
         type (locator | other) "locator"
         href CDATA #IMPLIED
         actuate (onLoad | onRequest | other | none) "onRequest"
         encoding (gzip | base64 | dynamic | none) "none"
         expires CDATA #IMPLIED
         rights CDATA #IMPLIED
 >

Methods

new($str_or_ref, %options)

Create a new VOTABLE::STREAM 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 STREAM element. If the first argument is a reference to a XML::DOM::Element object, that object is used to initialize the new STREAM element (implicitly assuming that the XML::DOM::Element object contains a valid STREAM 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::STREAM object. Return undef if an error occurs.

get_actuate

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

set_actuate($actuate)

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

get_encoding

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

set_encoding($encoding)

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

get_expires

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

set_expires($expires)

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

get_href

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

set_href($href)

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

get_rights

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

set_rights($rights)

Set the value of the rights 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.

Notes on class internals


WARNINGS


SEE ALSO

VOTABLE, VOTABLE::BINARY, VOTABLE::FITS


AUTHOR

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


VERSION

$Id: STREAM.pm,v 1.1.1.7 2002/05/21 14:13:06 elwinter Exp $