.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Xacobeo::Document 3pm"
.TH Xacobeo::Document 3pm "2011-11-16" "perl v5.14.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Xacobeo::Document \- An XML document and its related information.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&        use Xacobeo::Document;
\&        
\&        my $document = Xacobeo::Document\->new_from_file(\*(Aqfile.xml\*(Aq, \*(Aqxml\*(Aq);
\&        
\&        my $namespaces = $document\->get_namespaces(); # Hashref
\&        while (my ($uri, $prefix) = each %{ $namespaces }) {
\&                printf "%\-5s: %s\en", $prefix, $uri;
\&        }
\&        
\&        
\&        my $nodes = $document\->find(\*(Aq/x:html//x:a[@href]\*(Aq);
\&        foreach my $node ($nodes\->get_nodelist) {
\&                print "Got node ", $node\->name, "\en";
\&        }
\&        
\&        $document\->validate(\*(Aq/x:html//x:a[@href]\*(Aq) or die "Invalid XPath expression";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class wraps an \s-1XML\s0 document with its corresponding meta information
(namespaces, XPath context, document node, etc).
.PP
It inherits from Glib::Object.
.SH "PROPERTIES"
.IX Header "PROPERTIES"
The following properties are defined:
.SS "source"
.IX Subsection "source"
The source of the document. In most cases this will be a path or an \s-1URI\s0 pointing
to the document.
.SS "type"
.IX Subsection "type"
The type of document 'xml' or 'html'.
.SS "documentNode"
.IX Subsection "documentNode"
The document's main node (an instance of XML::LibXML::Node).
.SS "xpath"
.IX Subsection "xpath"
The XPath conext to be used with the document.
.SS "namespaces"
.IX Subsection "namespaces"
An hashref with the namespaces registered in the document.
.SH "METHODS"
.IX Header "METHODS"
The package defines the following methods:
.SS "new_from_file"
.IX Subsection "new_from_file"
Creates a new instance from a file (an \s-1URI\s0 should also be valid).
.PP
Parameters:
.PP
.Vb 2
\&        $source: the source of the document, this can be a filename or an URI.
\&        $type:   the type of document: C<xml> or C<html>.
.Ve
.SS "new_from_string"
.IX Subsection "new_from_string"
Creates a new instance from a string.
.PP
Parameters:
.PP
.Vb 2
\&        $content: the contents of the document.
\&        $type:    the type of document: C<xml> or C<html>.
.Ve
.SS "empty"
.IX Subsection "empty"
Returns an empty document.
.SS "source"
.IX Subsection "source"
The source of the document: most likely a file path or an \s-1URI\s0.
.SS "type"
.IX Subsection "type"
The type of document: \fIxml\fR or \fIhtml\fR.
.SS "namespaces"
.IX Subsection "namespaces"
Returns the namespaces declared in the document. The namespaces are returned in
a hashref where the URIs are used as a key and the prefix as a value.
.SS "documentNode"
.IX Subsection "documentNode"
Returns the document's node (an instance of XML::LibXML::Document).
.SS "xpath"
.IX Subsection "xpath"
Returns the XPath context (an instance of XML::LibXML::XPathContext) that
includes the namespaces declared in the document. This is the context used to
execute all XPath queries.
.SS "find"
.IX Subsection "find"
Runs the given XPath query on the document and returns the results. The results
could be a node list or a single value like a boolean, a number or a scalar if
an expression is passed. This method always return its values in scalar context.
.PP
This method croaks if the expression can't be evaluated.
.PP
Parameters:
.PP
.Vb 1
\&        $xpath: the XPath expression to execute.
.Ve
.SS "validate"
.IX Subsection "validate"
Validates the syntax of the given XPath query. The syntax is validated within a
context that has the same namespaces as the ones defined in the current \s-1XML\s0
document.
.PP
\&\fB\s-1NOTE\s0\fR: This method can't validate if undefined functions or variables are
used.
.PP
Parameters:
.PP
.Vb 1
\&        $xpath: the XPath expression to validate.
.Ve
.SS "get_prefixed_name"
.IX Subsection "get_prefixed_name"
Returns the node name by prefixing it with our prefixes in the case where
namespaces are used.
.SH "AUTHORS"
.IX Header "AUTHORS"
Emmanuel Rodriguez <potyl@cpan.org>.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2008,2009 by Emmanuel Rodriguez.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.8 or,
at your option, any later version of Perl 5 you may have available.