.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "XMLSpecContainer 3pm"
.TH XMLSpecContainer 3pm 2025-09-28 "Lire 2.1.1" "LogReport's Lire 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
Lire::XMLSpecContainer \- Base clase for XML report and filter specifications
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use base qw/Lire::XMLSpecContainer/;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is the base class for Lire::ReportSpec and Lire::FilterSpec which
are XML specifications used to compute reports. This man page document
the attributes common to both type of specification.
.ie n .SS "id( [ $new_id ] )"
.el .SS "id( [ \f(CW$new_id\fP ] )"
.IX Subsection "id( [ $new_id ] )"
Returns the type id of this specification. It \f(CW$new_id\fR is set, it will
change the id of the specification.
.ie n .SS "superservice( [ $new_superservice ] )"
.el .SS "superservice( [ \f(CW$new_superservice\fP ] )"
.IX Subsection "superservice( [ $new_superservice ] )"
Returns the superservice (aka base DLF schema) used by this
specification. It \f(CW$new_superservice\fR is set, it will change the
superservice of the specification.
.ie n .SS "schema( [ $new_schema ] )"
.el .SS "schema( [ \f(CW$new_schema\fP ] )"
.IX Subsection "schema( [ $new_schema ] )"
Returns the Lire::DLfSchema object used by this specification. This
can be the superservice or any of its Lire::ExtendedSchema or
Lire::DerivedSchema.
.PP
If \f(CW$new_schema\fR is a string, the specification\*(Aqs schema will be changed
to that schema. If \f(CW$new_schema\fR is undef, the base DlfSchema (aka
superservice) will be used.
.ie n .SS "joined_schemas( [ $new_schemas ] )"
.el .SS "joined_schemas( [ \f(CW$new_schemas\fP ] )"
.IX Subsection "joined_schemas( [ $new_schemas ] )"
Returns as an array reference, the list of schemas that are joined in
this specification.
.PP
If \f(CW$new_schemas\fR is set, the list of joined schemas will be changed to
that list. This is an array reference of schema name. All of these
schemas should be join compatible with the schema specified in the
\&\fBschema()\fR attribute.
.SS \fBschemas()\fP
.IX Subsection "schemas()"
Returns in an array reference all the schemas used by this
specification. This will include the base schema as well as any
joined schemas.
.ie n .SS "has_field( $name )"
.el .SS "has_field( \f(CW$name\fP )"
.IX Subsection "has_field( $name )"
Returns whether the field named \f(CW$name\fR is available in this
specification\*(Aqs schema or any of its joined schema.
.ie n .SS "field( $name )"
.el .SS "field( \f(CW$name\fP )"
.IX Subsection "field( $name )"
Returns the Lire::Field object named \f(CW$name\fR present in one of
the specification\*(Aqs joined schema.
.ie n .SS "title( [ $new_title ]"
.el .SS "title( [ \f(CW$new_title\fP ]"
.IX Subsection "title( [ $new_title ]"
This method returns the title of this specification. If \f(CW$new_title\fR is
set, the specification\*(Aqs title will be changed to that value.
.PP
The returned value is localized if a translation string is available.
The domain used for translation is \*(Aqlire\-<superservice\*(Aq.
.ie n .SS "description( [ $new_description ]"
.el .SS "description( [ \f(CW$new_description\fP ]"
.IX Subsection "description( [ $new_description ]"
This method returns the description of this specification. If
\&\f(CW$new_description\fR is set, the specification\*(Aqs description will be
changed to that value. That description is a DocBook string describing
the specification\*(Aqs purpose.
.PP
The returned value is localized if a translation string is available.
The domain used for translation is \*(Aqlire\-<superservice\*(Aq.
.ie n .SS "display_title( [ $new_title ]"
.el .SS "display_title( [ \f(CW$new_title\fP ]"
.IX Subsection "display_title( [ $new_title ]"
This method returns the title that will be displayed in the generated
specification. This value can contains reference to the
specification\*(Aqs parameters using the \*(Aq$name\*(Aq syntax.
.PP
If \f(CW$new_title\fR is set, the specification\*(Aqs display title will be changed
to that value.
.PP
The returned value is localized if a translation string is available.
The domain used for translation is \*(Aqlire\-<superservice\*(Aq.
.ie n .SS "display_description( [ $new_description ]"
.el .SS "display_description( [ \f(CW$new_description\fP ]"
.IX Subsection "display_description( [ $new_description ]"
This method returns the description that will be displayed in the
generated report. This value can contains reference to the
specification\*(Aqs parameters using the \*(Aq$name\*(Aq syntax.
.PP
If \f(CW$new_description\fR is set, the specification\*(Aqs description will be
changed to that value. That description is a DocBook string describing
the specification\*(Aqs purpose.
.PP
The returned value is localized if a translation string is available.
The domain used for translation is \*(Aqlire\-<superservice\*(Aq.
.SS \fBexpanded_display_title()\fP
.IX Subsection "expanded_display_title()"
Returns \fBdisplay_title()\fR with parameters reference expanded.
.SS \fBexpanded_display_description()\fP
.IX Subsection "expanded_display_description()"
Returns \fBdisplay_description()\fR with parameters reference expanded.
.ie n .SS "print( $fh )"
.el .SS "print( \f(CW$fh\fP )"
.IX Subsection "print( $fh )"
Prints this specification as XML on \f(CW$fh\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 1
\& Lire::ReportSpec(3pm), Lire::FilterSpec(3pm), Lire::XMLSpecParser(3pm)
.Ve
.SH AUTHORS
.IX Header "AUTHORS"
.Vb 2
\&  Francis J. Lacoste <flacoste@logreport.org>
\&  Wolfgang Sourdeau <wolfgang@logreport.org>
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR XMLSpecContainer.pm,v 1.41 2006/07/23 13:16:30 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2001\-2004 Stichting LogReport Foundation LogReport@LogReport.org
.PP
This file is part of Lire.
.PP
Lire is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program (see COPYING); if not, check with
http://www.gnu.org/copyleft/gpl.html.