NAME
perfSONAR_PS::Datatypes::v2_0::histogram::Message::Metadata::Parameters - A base class, implements 'parameters' element from the perfSONAR_PS RelaxNG schema
|
DESCRIPTION
Object representation of the parameters element.
Object fields are:
Scalar: id,
Object reference: parameter => type ARRAY,
The constructor accepts only single parameter, it could be a hashref to parameters hash or DOM with 'parameters' element
|
SYNOPSIS
my $el = perfSONAR_PS::Datatypes::v2_0::histogram::Message::Metadata::Parameters->new($DOM_Obj);
|
METHODS
new( )
creates object, accepts DOM with element tree or hashref to the list of
keyd parameters
id => undef,
parameter => ARRAY,
|
getDOM ($)
accept parent DOM
return parameters object DOM, generated from object contents
|
addparameter()
if any of subelements can be an arrray then this method will provide
facility to add another element to the array and will return ref to such array
or just set the element to a new one
|
removeParameterById()
remove specific element from the array of parameter elements by id ( if id is supported by this element )
accepts single param - id - which is id attribute of the element
if there is no array then it will return undef and warninig
|
get specific object from the array of parameter elements by MetadataIdRef( if MetadataIdRef is supported by this element )
accepts single param - MetadataIdRef
if there is no array then it will return just an object
|
getParameterById()
get specific element from the array of parameter elements by id ( if id is supported by this element )
accepts single param - id
if there is no array then it will return just an object
|
querySQL ()
depending on config it will return some hash ref to the initialized fields
for example querySQL ()
accepts one optional prameter - query hashref
will return:
{ ip_name_src => 'hepnrc1.hep.net' },}
|
merge
merge with another parameters ( append + overwrite if exists )
we can do it differently
method
convert to dom both objects and then get resulted object from combined dom
method
through the introspection of the object
|
buildIdMap()
if any of subelements has id then get a map of it in form of
hashref to { element}{id} = index in array and store in the idmap field
|
buildrefIdMap ()
if any of subelements has metadataIdRef then get a map of it in form of
hashref to { element}{ metadataIdRef } = index in array and store in the idmap field
|
asString()
shortcut to get DOM and convert into the XML string
returns XML string representation of the parameters object
|
registerNamespaces ()
will parse all subelements and register all namepspaces within the parameters namespace
|
fromDOM ($)
accepts parent XML DOM element tree as parameter
returns parameters object
|
AUTHORS
Maxim Grigoriev (FNAL) 2007, maxim@fnal.gov
|