Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xml::stream::namespace(3) [suse man page]

XML::Stream::Namespace(3)				User Contributed Perl Documentation				 XML::Stream::Namespace(3)

NAME

       XML::Stream::Namespace - Object to make defining Namespaces easier in
				XML::Stream.

SYNOPSIS

       XML::Stream::Namespace is a helper package to XML::Stream.  It provides a clean way of defining Namespaces for XML::Stream to use when
       connecting.

DESCRIPTION

	 This module allows you to set and read elements from an XML::Stream
	 Namespace.

METHODS

	 SetNamespace("mynamespace");
	 SetXMLNS("http://www.mynamespace.com/xmlns");
	 SetAttributes(attrib1=>"value1",
		       attrib2=>"value2");

	 GetNamespace() returns "mynamespace"
	 GetXMLNS() returns "http://www.mynamespace.com/xmlns"
	 GetAttributes() returns a hash ( attrib1=>"value1",attrib2=>"value2")
	 GetStream() returns the following string:
	   "xmlns:mynamespace='http://www.nynamespace.com/xmlns'
	    mynamespace:attrib1='value1'
	    mynamespace:attrib2='value2'"

EXAMPLES

	 $myNamespace = new XML::Stream::Namespace("mynamspace");
	 $myNamespace->SetXMLNS("http://www.mynamespace.org/xmlns");
	 $myNamespace->SetAttributes(foo=>"bar",
				     bob=>"vila");

	 $stream = new XML::Stream;
	 $stream->Connect(name=>"foo.bar.org",
			  port=>1234,
			  namespace=>"foo:bar",
			  namespaces=>[ $myNamespace ]);

	 #
	 # The above Connect will send the following as the opening string
	 # of the stream to foo.bar.org:1234...
	 #
	 #   <stream:stream
	 #    xmlns:stream="http://etherx.jabber.org/streams"
	 #    to="foo.bar.org"
	 #    xmlns="foo:bar"
	 #    xmlns:mynamespace="http://www.mynamespace.org/xmlns"
	 #    mynamespace:foo="bar"
	 #    mynamespace:bob="vila">
	 #

AUTHOR

       Written by Ryan Eatmon in February 2000 Idea By Thomas Charron in January of 2000 for http://etherx.jabber.org/streams/

       Currently maintained by Darian Anthony Patrick.

COPYRIGHT

       This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.12.1							    2010-01-08						 XML::Stream::Namespace(3)

Check Out this Related Man Page

XML::Stream::Node(3pm)					User Contributed Perl Documentation				    XML::Stream::Node(3pm)

NAME

       XML::Stream::Node - Functions to make building and parsing the tree easier to work with.

SYNOPSIS

	 Just a collection of functions that do not need to be in memory if you
       choose one of the other methods of data storage.

	 This creates a hierarchy of Perl objects and provides various methods
       to manipulate the structure of the tree.  It is much like the C library
       libxml.

FORMAT

       The result of parsing:

	 <foo><head id="a">Hello <em>there</em></head><bar>Howdy<ref/></bar>do</foo>

       would be:

	 [ tag:       foo
	   att:       {}
	   children:  [ tag:	  head
			att:	  {id=>"a"}
			children: [ tag:      "__xmlstream__:node:cdata"
				    children: "Hello "
				  ]
				  [ tag:      em
				    children: [ tag:	  "__xmlstream__:node:cdata"
						children: "there"
					      ]
				  ]
		      ]
		      [ tag:	  bar
			children: [ tag:      "__xmlstream__:node:cdata"
				    children: "Howdy "
				  ]
				  [ tag:      ref
				  ]
		      ]
		      [ tag:	  "__xmlstream__:node:cdata"
			children: "do"
		      ]
	 ]

METHODS

	 new()		- creates a new node.  If you specify tag, then the root
	 new(tag)	  tag is set.  If you specify data, then cdata is added
	 new(tag,cdata)   to the node as well.	Returns the created node.

	 get_tag() - returns the root tag of the node.

	 set_tag(tag) - set the root tag of the node to tag.

	 add_child(node)      - adds the specified node as a child to the current
	 add_child(tag) 	node, or creates a new node with the specified tag
	 add_child(tag,cdata)	as the root node.  Returns the node added.

	 remove_child(node) - removes the child node from the current node.

	 remove_cdata() - removes all of the cdata children from the current node.

	 add_cdata(string) - adds the string as cdata onto the current nodes
			     child list.

	 get_cdata() - returns all of the cdata children concatenated together
		       into one string.

	 get_attrib(attrib) - returns the value of the attrib if it is valid,
			      or returns undef is attrib is not a real
			      attribute.

	 put_attrib(hash) - for each key/value pair specified, create an
			    attribute in the node.

	 remove_attrib(attrib) - remove the specified attribute from the node.

	 add_raw_xml(string,[string,...]) - directly add a string into the XML
					    packet as the last child, with no
					    translation.

	 get_raw_xml() - return all of the XML in a single string, undef if there
			 is no raw XML to include.

	 remove_raw_xml() - remove all raw XML strings.

	 children() - return all of the children of the node in a list.

	 attrib() - returns a hash containing all of the attributes on this
		    node.

	 copy() - return a recursive copy of the node.

	 XPath(path) - run XML::Stream::XPath on this node.

	 XPathCheck(path) - run XML::Stream::XPath on this node and return 1 or 0
			    to see if it matches or not.

	 GetXML() - return the node in XML string form.

AUTHOR

       By Ryan Eatmon in June 2002 for http://jabber.org/

       Currently maintained by Darian Anthony Patrick.

COPYRIGHT

       This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.14.2							    2010-01-08						    XML::Stream::Node(3pm)
Man Page