.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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" ''
.    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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "XML::Compile::Cache 3pm"
.TH XML::Compile::Cache 3pm "2016-10-31" "perl v5.24.1" "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"
XML::Compile::Cache \- Cache compiled XML translators
.SH "INHERITANCE"
.IX Header "INHERITANCE"
.Vb 3
\& XML::Compile::Cache
\&   is a XML::Compile::Schema
\&   is a XML::Compile
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& my $cache = XML::Compile::Cache\->new(...);
\&
\& $cache\->declare(\*(AqREADER\*(Aq,  $type,  @options);
\& $cache\->declare(RW     => \e@types, @options);
\& $cache\->declare(WRITER =>  $type, \e@options);
\&
\& $cache\->compileAll;
\& $cache\->compileAll(\*(AqRW\*(Aq);
\&
\& # get the cached code ref for the reader
\& my $reader = $cache\->reader($type, @opts);
\& use Data::Dumper;
\& print Dumper $reader\->($xml);
\&
\& # get the cached code ref for the writer, and use it
\& my $doc = XML::LibXML::Document\->new(\*(Aq1.0\*(Aq, \*(AqUTF\-8\*(Aq);
\& my $xml = $cache\->writer($type)\->($doc, $perl);
\& print $xml\->toString(1);
\&
\& # use the base\-class uncached, the XML::Compile::Schema
\& my $do = $cache\->compile(READER => $type, @opts);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Extends \*(L"\s-1DESCRIPTION\*(R"\s0 in XML::Compile::Schema.
.SH "METHODS"
.IX Header "METHODS"
Extends \*(L"\s-1METHODS\*(R"\s0 in XML::Compile::Schema.
.SS "Constructors"
.IX Subsection "Constructors"
Extends \*(L"Constructors\*(R" in XML::Compile::Schema.
.ie n .IP "XML::Compile::Cache\->\fBnew\fR( [$xml], %options )" 4
.el .IP "XML::Compile::Cache\->\fBnew\fR( [$xml], \f(CW%options\fR )" 4
.IX Item "XML::Compile::Cache->new( [$xml], %options )"
.Vb 10
\& \-Option            \-\-Defined in          \-\-Default
\&  allow_undeclared                          <false>
\&  any_element                               \*(AqATTEMPT\*(Aq
\&  block_namespace     XML::Compile::Schema  []
\&  hook                XML::Compile::Schema  undef
\&  hooks               XML::Compile::Schema  []
\&  ignore_unused_tags  XML::Compile::Schema  <false>
\&  key_rewrite         XML::Compile::Schema  []
\&  opts_readers                              []
\&  opts_rw                                   []
\&  opts_writers                              []
\&  parser_options      XML::Compile          <many>
\&  prefixes                                  <smart>
\&  schema_dirs         XML::Compile          undef
\&  typemap                                   {}
\&  xsi_type                                  {}
.Ve
.RS 4
.IP "allow_undeclared => \s-1BOOLEAN\s0" 2
.IX Item "allow_undeclared => BOOLEAN"
When true, you may call the reader or writer with types which were
not registered with \fIdeclare()\fR.  In that case, the reader or
writer may also get options passed for the compiler, as long as
they are consistent over each use of the type.
.IP "any_element => CODE|'\s-1TAKE_ALL\s0'|'\s-1SKIP_ALL\s0'|'\s-1ATTEMPT\s0'|'\s-1SLOPPY\s0'" 2
.IX Item "any_element => CODE|'TAKE_ALL'|'SKIP_ALL'|'ATTEMPT'|'SLOPPY'"
See \fIanyElement()\fR.
.Sp
[1.02] the default is to \s-1ATTEMPT\s0 compiling any handlers automatically.
Before version 1.02, the default was to \s-1SKIP_ALL\s0 elements which would
match the occurs and namespace restrictions of the any specification.
However, that fails for reperative blocks (for instance, it fails for
an choice which may occur unbounded times)
.IP "block_namespace => NAMESPACE|TYPE|HASH|CODE|ARRAY" 2
.IX Item "block_namespace => NAMESPACE|TYPE|HASH|CODE|ARRAY"
.PD 0
.IP "hook => HOOK|ARRAY" 2
.IX Item "hook => HOOK|ARRAY"
.IP "hooks => \s-1ARRAY\s0" 2
.IX Item "hooks => ARRAY"
.IP "ignore_unused_tags => BOOLEAN|REGEXP" 2
.IX Item "ignore_unused_tags => BOOLEAN|REGEXP"
.IP "key_rewrite => HASH|CODE|ARRAY" 2
.IX Item "key_rewrite => HASH|CODE|ARRAY"
.IP "opts_readers => HASH|ARRAY\-of\-PAIRS" 2
.IX Item "opts_readers => HASH|ARRAY-of-PAIRS"
.IP "opts_rw => HASH|ARRAY\-of\-PAIRS" 2
.IX Item "opts_rw => HASH|ARRAY-of-PAIRS"
.PD
Options added to both READERs and \s-1WRITERS. \s0 Options which are passed
with \fIdeclare()\fR and \f(CW\*(C`opts_readers\*(C'\fR or \f(CW\*(C`opts_writers\*(C'\fR will overrule
these.  See \fIaddCompileOptions()\fR.
.IP "opts_writers => HASH|ARRAY\-of\-PAIRS" 2
.IX Item "opts_writers => HASH|ARRAY-of-PAIRS"
.PD 0
.IP "parser_options => HASH|ARRAY" 2
.IX Item "parser_options => HASH|ARRAY"
.IP "prefixes => HASH|ARRAY\-of\-PAIRS" 2
.IX Item "prefixes => HASH|ARRAY-of-PAIRS"
.PD
Define prefix name to name-space mappings.  Passed to compile(prefixes)
for each reader and writer, but also used to permit \fIfindName()\fR to
accept types which use a prefix.
.Sp
Specify an \s-1ARRAY\s0 of (prefix, name-space) pairs, or a \s-1HASH\s0 which maps
name-spaces to prefixes (\s-1HASH\s0 order is reversed from \s-1ARRAY\s0 order!)  When
you wish to collect the results, like usage counts, of the translation
processing, you will need to specify a \s-1HASH.\s0
.Sp
.Vb 2
\& prefixes => [ mine => $myns, your => $yourns ]
\& prefixes => { $myns => \*(Aqmine\*(Aq, $yourns => \*(Aqyour\*(Aq }
\&
\& # the previous is short for:
\& prefixes => { $myns => [ uri => $myns, prefix => \*(Aqmine\*(Aq, used => 0 ]
\&             , $yourns => [ uri => $yourns, prefix => \*(Aqyour\*(Aq, ...] }
.Ve
.IP "schema_dirs => DIRECTORY|ARRAY\-OF\-DIRECTORIES" 2
.IX Item "schema_dirs => DIRECTORY|ARRAY-OF-DIRECTORIES"
.PD 0
.IP "typemap => HASH|ARRAY" 2
.IX Item "typemap => HASH|ARRAY"
.IP "xsi_type => HASH|ARRAY" 2
.IX Item "xsi_type => HASH|ARRAY"
.RE
.RS 4
.RE
.PD
.SS "Accessors"
.IX Subsection "Accessors"
Extends \*(L"Accessors\*(R" in XML::Compile::Schema.
.ie n .IP "$obj\->\fBaddHook\fR($hook|LIST|undef)" 4
.el .IP "\f(CW$obj\fR\->\fBaddHook\fR($hook|LIST|undef)" 4
.IX Item "$obj->addHook($hook|LIST|undef)"
Inherited, see \*(L"Accessors\*(R" in XML::Compile::Schema
.ie n .IP "$obj\->\fBaddHooks\fR( $hook, [$hook, ...] )" 4
.el .IP "\f(CW$obj\fR\->\fBaddHooks\fR( \f(CW$hook\fR, [$hook, ...] )" 4
.IX Item "$obj->addHooks( $hook, [$hook, ...] )"
Inherited, see \*(L"Accessors\*(R" in XML::Compile::Schema
.ie n .IP "$obj\->\fBaddKeyRewrite\fR($predef|CODE|HASH, ...)" 4
.el .IP "\f(CW$obj\fR\->\fBaddKeyRewrite\fR($predef|CODE|HASH, ...)" 4
.IX Item "$obj->addKeyRewrite($predef|CODE|HASH, ...)"
Inherited, see \*(L"Accessors\*(R" in XML::Compile::Schema
.ie n .IP "$obj\->\fBaddSchemaDirs\fR(@directories|$filename)" 4
.el .IP "\f(CW$obj\fR\->\fBaddSchemaDirs\fR(@directories|$filename)" 4
.IX Item "$obj->addSchemaDirs(@directories|$filename)"
.PD 0
.IP "XML::Compile::Cache\->\fBaddSchemaDirs\fR(@directories|$filename)" 4
.IX Item "XML::Compile::Cache->addSchemaDirs(@directories|$filename)"
.PD
Inherited, see \*(L"Accessors\*(R" in XML::Compile
.ie n .IP "$obj\->\fBaddSchemas\fR($xml, %options)" 4
.el .IP "\f(CW$obj\fR\->\fBaddSchemas\fR($xml, \f(CW%options\fR)" 4
.IX Item "$obj->addSchemas($xml, %options)"
Inherited, see \*(L"Accessors\*(R" in XML::Compile::Schema
.ie n .IP "$obj\->\fBaddTypemap\fR(\s-1PAIR\s0)" 4
.el .IP "\f(CW$obj\fR\->\fBaddTypemap\fR(\s-1PAIR\s0)" 4
.IX Item "$obj->addTypemap(PAIR)"
Inherited, see \*(L"Accessors\*(R" in XML::Compile::Schema
.ie n .IP "$obj\->\fBaddTypemaps\fR(\s-1PAIRS\s0)" 4
.el .IP "\f(CW$obj\fR\->\fBaddTypemaps\fR(\s-1PAIRS\s0)" 4
.IX Item "$obj->addTypemaps(PAIRS)"
Inherited, see \*(L"Accessors\*(R" in XML::Compile::Schema
.ie n .IP "$obj\->\fBaddXsiType\fR( [HASH|ARRAY|LIST] )" 4
.el .IP "\f(CW$obj\fR\->\fBaddXsiType\fR( [HASH|ARRAY|LIST] )" 4
.IX Item "$obj->addXsiType( [HASH|ARRAY|LIST] )"
[1.01] add global xsi_type declarations.  Returns the xsiType set.
The \s-1ARRAY\s0 or \s-1LIST\s0 contains pairs, just like the \s-1HASH.\s0
.Sp
The value component can be '\s-1AUTO\s0' to automatically detect the \f(CW\*(C`xsi:type\*(C'\fR
extensions.  This does only work for complex types.
.ie n .IP "$obj\->\fBallowUndeclared\fR( [\s-1BOOLEAN\s0] )" 4
.el .IP "\f(CW$obj\fR\->\fBallowUndeclared\fR( [\s-1BOOLEAN\s0] )" 4
.IX Item "$obj->allowUndeclared( [BOOLEAN] )"
Whether it is permitted to create readers and writers which are not
declared cleanly.
.ie n .IP "$obj\->\fBanyElement\fR('\s-1ATTEMPT\s0'|'\s-1SLOPPY\s0'|'\s-1SKIP_ALL\s0'|'\s-1TAKE_ALL\s0'|CODE)" 4
.el .IP "\f(CW$obj\fR\->\fBanyElement\fR('\s-1ATTEMPT\s0'|'\s-1SLOPPY\s0'|'\s-1SKIP_ALL\s0'|'\s-1TAKE_ALL\s0'|CODE)" 4
.IX Item "$obj->anyElement('ATTEMPT'|'SLOPPY'|'SKIP_ALL'|'TAKE_ALL'|CODE)"
[as method since 0.99] How to process \s-1ANY\s0 elements, see also
new(any_element).
.Sp
Reader: \f(CW\*(C`ATTEMPT\*(C'\fR will convert all any elements, applying the reader for
each element found. When an element is not found in a schema, it will
be included as XML::LibXML::Element node.
.Sp
[0.93] Reader: With \f(CW\*(C`SLOPPY\*(C'\fR, first automatic typed conversion is
attempted. But is the type is not known, \fIXML::LibXML::Simple::XMLin()\fR
is called to the resque.
.ie n .IP "$obj\->\fBblockNamespace\fR($ns|$type|HASH|CODE|ARRAY)" 4
.el .IP "\f(CW$obj\fR\->\fBblockNamespace\fR($ns|$type|HASH|CODE|ARRAY)" 4
.IX Item "$obj->blockNamespace($ns|$type|HASH|CODE|ARRAY)"
Inherited, see \*(L"Accessors\*(R" in XML::Compile::Schema
.ie n .IP "$obj\->\fBhooks\fR( [<'\s-1READER\s0'|'\s-1WRITER\s0'>] )" 4
.el .IP "\f(CW$obj\fR\->\fBhooks\fR( [<'\s-1READER\s0'|'\s-1WRITER\s0'>] )" 4
.IX Item "$obj->hooks( [<'READER'|'WRITER'>] )"
Inherited, see \*(L"Accessors\*(R" in XML::Compile::Schema
.ie n .IP "$obj\->\fBtypemap\fR( [HASH|ARRAY|PAIRS] )" 4
.el .IP "\f(CW$obj\fR\->\fBtypemap\fR( [HASH|ARRAY|PAIRS] )" 4
.IX Item "$obj->typemap( [HASH|ARRAY|PAIRS] )"
[0.98] Add global knowledge on typemaps.  Returns the typemap.
.ie n .IP "$obj\->\fBuseSchema\fR( $schema, [$schema, ...] )" 4
.el .IP "\f(CW$obj\fR\->\fBuseSchema\fR( \f(CW$schema\fR, [$schema, ...] )" 4
.IX Item "$obj->useSchema( $schema, [$schema, ...] )"
Inherited, see \*(L"Accessors\*(R" in XML::Compile::Schema
.SS "Prefix management"
.IX Subsection "Prefix management"
The cache layer on top of XML::Compile::Schema adds smart use of
prefixes.  Of course, smartness comes with a small performance cost,
but the code gets much cleaner.
.ie n .IP "$obj\->\fBaddNicePrefix\fR(\s-1BASE, NAMESPACE\s0)" 4
.el .IP "\f(CW$obj\fR\->\fBaddNicePrefix\fR(\s-1BASE, NAMESPACE\s0)" 4
.IX Item "$obj->addNicePrefix(BASE, NAMESPACE)"
[1.03] Register \s-1NAMESPACE\s0 \-if not yet defined\- with prefix name \s-1BASE. \s0 When
that prefix name is already in use for some other namespace, \s-1BASE\s0 followed
by a number are attempted (starting with 01).  The prefix is returned.
.Sp
When the \s-1BASE\s0 already ends on a number, that number will get counted.
.Sp
example:
.Sp
.Vb 2
\&  my $prefix = $schema\->addNicePrefix(\*(Aqcall\*(Aq, $myns);
\&  # $prefix now can be call, call01, call02 etc
.Ve
.ie n .IP "$obj\->\fBaddPrefixes\fR( [PAIRS|ARRAY|HASH] )" 4
.el .IP "\f(CW$obj\fR\->\fBaddPrefixes\fR( [PAIRS|ARRAY|HASH] )" 4
.IX Item "$obj->addPrefixes( [PAIRS|ARRAY|HASH] )"
The X::C logic does auto-detect prefix/namespaces combinations from
the \s-1XML,\s0 but does not search extensively for namespace declarations.
Also, sometimes the same namespace is used with different prefixes.
Sometimes, the same prefix is used for different namesapces.  To complete
the list, or control the actual prefix being used, you explicitly declare
combinations.
.Sp
The \fBbest way\fR to add prefixes is via new(prefixes), which will give
your names preference over the names found in the schema's which get loaded.
For instance, use \f(CW\*(C`::WSDL\->new(prefixes => [ $prefix => $ns ]\*(C'\fR
.Sp
[0.995] Returns the \s-1HASH\s0 with prefix to name-space translations.  You should
not modify the returned \s-1HASH:\s0 new \s-1PAIRS\s0 of prefix to namespace relations
can be passed as arguments.
.Sp
[0.14] If a name-space appears for the second time, then the new
prefix will be recognized by \fIfindName()\fR, but not used in the output.
When the prefix already exists for a different namespace, then an error
will be casted.
.Sp
[0.90] You may also provide an \s-1ARRAY\s0 of pairs or a \s-1HASH.\s0
.ie n .IP "$obj\->\fBlearnPrefixes\fR($node)" 4
.el .IP "\f(CW$obj\fR\->\fBlearnPrefixes\fR($node)" 4
.IX Item "$obj->learnPrefixes($node)"
[0.993] Take all the prefixes defined in the \f(CW$node\fR, and XML::LibXML::Element.
This is not recursive: only on those defined at the top \f(CW$node\fR.
.ie n .IP "$obj\->\fBprefix\fR($prefix)" 4
.el .IP "\f(CW$obj\fR\->\fBprefix\fR($prefix)" 4
.IX Item "$obj->prefix($prefix)"
Lookup a prefix definition.  This returns a \s-1HASH\s0 with namespace info.
.ie n .IP "$obj\->\fBprefixFor\fR($uri)" 4
.el .IP "\f(CW$obj\fR\->\fBprefixFor\fR($uri)" 4
.IX Item "$obj->prefixFor($uri)"
Lookup the preferred prefix for the \f(CW$uri\fR.
.ie n .IP "$obj\->\fBprefixed\fR( $type|<$ns,$local> )" 4
.el .IP "\f(CW$obj\fR\->\fBprefixed\fR( \f(CW$type\fR|<$ns,$local> )" 4
.IX Item "$obj->prefixed( $type|<$ns,$local> )"
Translate the fully qualified \f(CW$type\fR into a prefixed version.  Will produce
undef if the namespace is unknown.
.Sp
[0.993] When your \f(CW$type\fR is not in packed form, you can specify a namespace
and \f(CW$local\fR type name as separate arguments.
.Sp
example:
.Sp
.Vb 2
\&   print $schema\->prefixed($type) || $type;
\&   print $schema\->prefixed($ns, $local);
.Ve
.ie n .IP "$obj\->\fBprefixes\fR( [$params] )" 4
.el .IP "\f(CW$obj\fR\->\fBprefixes\fR( [$params] )" 4
.IX Item "$obj->prefixes( [$params] )"
Return prefixes table.  The \f(CW$params\fR are deprecated since [0.995], see
\&\fIaddPrefixes()\fR.
.SS "Compilers"
.IX Subsection "Compilers"
The name of this module refers to its power to administer compiled
\&\s-1XML\s0 encoders (writers) and decoders (readers).  This means that
your program only need to pass on a ::Cache object (for instance
a XML::Compile::WSDL11, not a \s-1CODE\s0 reference for each compiled
translator.
.PP
Extends \*(L"Compilers\*(R" in XML::Compile::Schema.
.ie n .IP "$obj\->\fBaddCompileOptions\fR( ['\s-1READERS\s0'|'\s-1WRITERS\s0'|'\s-1RW\s0'], %options )" 4
.el .IP "\f(CW$obj\fR\->\fBaddCompileOptions\fR( ['\s-1READERS\s0'|'\s-1WRITERS\s0'|'\s-1RW\s0'], \f(CW%options\fR )" 4
.IX Item "$obj->addCompileOptions( ['READERS'|'WRITERS'|'RW'], %options )"
[0.99] You may provide global compile options with new(opts_rw),
\&\f(CW\*(C`opts_readers\*(C'\fR and \f(CW\*(C`opts_writers\*(C'\fR, but also later using this method.
.ie n .IP "$obj\->\fBcompile\fR( <'\s-1READER\s0'|'\s-1WRITER\s0'>, $type, %options )" 4
.el .IP "\f(CW$obj\fR\->\fBcompile\fR( <'\s-1READER\s0'|'\s-1WRITER\s0'>, \f(CW$type\fR, \f(CW%options\fR )" 4
.IX Item "$obj->compile( <'READER'|'WRITER'>, $type, %options )"
Inherited, see \*(L"Compilers\*(R" in XML::Compile::Schema
.ie n .IP "$obj\->\fBcompileAll\fR( ['\s-1READERS\s0'|'\s-1WRITERS\s0'|'\s-1RW\s0', [$ns]] )" 4
.el .IP "\f(CW$obj\fR\->\fBcompileAll\fR( ['\s-1READERS\s0'|'\s-1WRITERS\s0'|'\s-1RW\s0', [$ns]] )" 4
.IX Item "$obj->compileAll( ['READERS'|'WRITERS'|'RW', [$ns]] )"
Compile all the declared readers and writers with the default '\s-1RW\s0').  You may
also select to pre-compile only the \s-1READERS\s0 or only the \s-1WRITERS. \s0 The
selection can be limited further by specifying a \f(CW$ns\fR.
.Sp
By default, the processors are only compiled when used.  This method is
especially useful in a \fBdaemon process\fR, where preparations can take as
much time as they want to... and running should be as fast as possible.
.ie n .IP "$obj\->\fBcompileType\fR( <'\s-1READER\s0'|'\s-1WRITER\s0'>, $type, %options )" 4
.el .IP "\f(CW$obj\fR\->\fBcompileType\fR( <'\s-1READER\s0'|'\s-1WRITER\s0'>, \f(CW$type\fR, \f(CW%options\fR )" 4
.IX Item "$obj->compileType( <'READER'|'WRITER'>, $type, %options )"
Inherited, see \*(L"Compilers\*(R" in XML::Compile::Schema
.ie n .IP "$obj\->\fBdataToXML\fR( $node|REF\-XML|XML\-STRING|$filename|$fh|$known )" 4
.el .IP "\f(CW$obj\fR\->\fBdataToXML\fR( \f(CW$node\fR|REF\-XML|XML\-STRING|$filename|$fh|$known )" 4
.IX Item "$obj->dataToXML( $node|REF-XML|XML-STRING|$filename|$fh|$known )"
.PD 0
.ie n .IP "XML::Compile::Cache\->\fBdataToXML\fR( $node|REF\-XML|XML\-STRING|$filename|$fh|$known )" 4
.el .IP "XML::Compile::Cache\->\fBdataToXML\fR( \f(CW$node\fR|REF\-XML|XML\-STRING|$filename|$fh|$known )" 4
.IX Item "XML::Compile::Cache->dataToXML( $node|REF-XML|XML-STRING|$filename|$fh|$known )"
.PD
Inherited, see \*(L"Compilers\*(R" in XML::Compile
.ie n .IP "$obj\->\fBinitParser\fR(%options)" 4
.el .IP "\f(CW$obj\fR\->\fBinitParser\fR(%options)" 4
.IX Item "$obj->initParser(%options)"
.PD 0
.IP "XML::Compile::Cache\->\fBinitParser\fR(%options)" 4
.IX Item "XML::Compile::Cache->initParser(%options)"
.PD
Inherited, see \*(L"Compilers\*(R" in XML::Compile
.ie n .IP "$obj\->\fBreader\fR($type|$name, %options)" 4
.el .IP "\f(CW$obj\fR\->\fBreader\fR($type|$name, \f(CW%options\fR)" 4
.IX Item "$obj->reader($type|$name, %options)"
Returns the reader \s-1CODE\s0 for the \f(CW$type\fR or \f(CW$name\fR (see \fIfindName()\fR).
\&\f(CW%options\fR are only permitted if new(allow_undeclared) is true, and the
same as the previous call to this method.
.Sp
The reader will be compiled the first time that it is used, and that
same \s-1CODE\s0 reference will be returned each next request for the same
\&\f(CW$type\fR.  Call \fIcompileAll()\fR to have all readers compiled by force.
.Sp
.Vb 2
\& \-Option \-\-Default
\&  is_type  <false>
.Ve
.RS 4
.IP "is_type => \s-1BOOLEAN\s0" 2
.IX Item "is_type => BOOLEAN"
[1.03] use \fIcompileType()\fR with the given element, to replace \fIcompile()\fR
You probably want an additional \f(CW\*(C`element\*(C'\fR parameter.
.RE
.RS 4
.Sp
example:
.Sp
.Vb 3
\&  my $schema = XML::Compile::Cache\->new(\e@xsd,
\&     prefixes => [ gml => $GML_NAMESPACE ] );
\&  my $data   = $schema\->reader(\*(Aqgml:members\*(Aq)\->($xml);
\&
\&  my $getmem = $schema\->reader(\*(Aqgml:members\*(Aq);
\&  my $data   = $getmem\->($xml);
.Ve
.RE
.ie n .IP "$obj\->\fBtemplate\fR( <'\s-1XML\s0'|'\s-1PERL\s0'|'\s-1TREE\s0'>, $element, %options )" 4
.el .IP "\f(CW$obj\fR\->\fBtemplate\fR( <'\s-1XML\s0'|'\s-1PERL\s0'|'\s-1TREE\s0'>, \f(CW$element\fR, \f(CW%options\fR )" 4
.IX Item "$obj->template( <'XML'|'PERL'|'TREE'>, $element, %options )"
Inherited, see \*(L"Compilers\*(R" in XML::Compile::Schema
.ie n .IP "$obj\->\fBwriter\fR($type|$name)" 4
.el .IP "\f(CW$obj\fR\->\fBwriter\fR($type|$name)" 4
.IX Item "$obj->writer($type|$name)"
Returns the writer \s-1CODE\s0 for the \f(CW$type\fR or \f(CW$name\fR (see \fIfindName()\fR).
\&\s-1OPTIONS\s0 are only permitted if new(allow_undeclared) is true, and the
same as the previous call to this method.
.Sp
The writer will be compiled the first time that it is used, and that
same \s-1CODE\s0 reference will be returned each next request for the same
type.
.Sp
.Vb 2
\& \-Option \-\-Default
\&  is_type  <false>
.Ve
.RS 4
.IP "is_type => \s-1BOOLEAN\s0" 2
.IX Item "is_type => BOOLEAN"
[1.03] use \fIcompileType()\fR with the given element, to replace \fIcompile()\fR
You probably want an additional \f(CW\*(C`element\*(C'\fR parameter.
.RE
.RS 4
.Sp
example:
.Sp
.Vb 1
\&  my $xml = $cache\->writer(\*(Aqgml:members\*(Aq)\->($doc, $data);
\&
\&  my $doc = XML::LibXML::Document\->new(\*(Aq1.0\*(Aq, \*(AqUTF\-8\*(Aq);
\&  my $wr  = $cache\->writer(\*(Aqgml:members\*(Aq);
\&  my $xml = $wr\->($doc, $data);
\&  $doc\->setDocumentElement($xml);
\&  print $doc\->toString(1);
.Ve
.RE
.SS "Administration"
.IX Subsection "Administration"
Extends \*(L"Administration\*(R" in XML::Compile::Schema.
.ie n .IP "$obj\->\fBdeclare\fR( <'\s-1READER\s0'|'\s-1WRITER\s0'|'\s-1RW\s0'>, <$type|ARRAY>, %options )" 4
.el .IP "\f(CW$obj\fR\->\fBdeclare\fR( <'\s-1READER\s0'|'\s-1WRITER\s0'|'\s-1RW\s0'>, <$type|ARRAY>, \f(CW%options\fR )" 4
.IX Item "$obj->declare( <'READER'|'WRITER'|'RW'>, <$type|ARRAY>, %options )"
Register that the indicated \f(CW$type\fR (or \s-1ARRAY\s0 of them) may be used, and needs to
be translated with the \f(CW%options\fR (either specified as \s-1ARRAY\s0 or \s-1PAIRS\s0).
Specify whether it may get used as \s-1READER, WRITER,\s0 or both (\s-1RW\s0).  If the
\&\s-1READER\s0 and \s-1WRITER\s0 need different options, then you need to declare them
separately; in that case you cannot use \s-1RW.\s0
.Sp
The \f(CW$type\fR should be understood by \fIfindName()\fR, so may be prefixed.
.Sp
example:
.Sp
.Vb 2
\&  $cache\->declare(READER => \*(Aqpref:count\*(Aq, sloppy_integers => 1)
\&        \->declare(RW     => \*(Aq{myns}mylocal\*(Aq);
\&
\&  $cache\->declare(WRITER => [ \*(Aqxsd:int\*(Aq, \*(Aq{http://}aap\*(Aq ]);
.Ve
.ie n .IP "$obj\->\fBdoesExtend\fR($exttype, $basetype)" 4
.el .IP "\f(CW$obj\fR\->\fBdoesExtend\fR($exttype, \f(CW$basetype\fR)" 4
.IX Item "$obj->doesExtend($exttype, $basetype)"
Inherited, see \*(L"Administration\*(R" in XML::Compile::Schema
.ie n .IP "$obj\->\fBelements\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBelements\fR()" 4
.IX Item "$obj->elements()"
Inherited, see \*(L"Administration\*(R" in XML::Compile::Schema
.ie n .IP "$obj\->\fBfindName\fR($name)" 4
.el .IP "\f(CW$obj\fR\->\fBfindName\fR($name)" 4
.IX Item "$obj->findName($name)"
Translate the \f(CW$name\fR specification into a schema defined full type.
The \f(CW$name\fR can be a full type (like '{namespace}localname', usually
created with \fIXML::Compile::Util::pack_type()\fR) or a prefixed type
(like 'myns:localname', where \f(CW\*(C`myns\*(C'\fR is defined via new(prefixes)
or \fIprefixes()\fR).
.Sp
When the form is 'myns:' (so without local name), the namespace uri is
returned.
.Sp
example: of \fIfindName()\fR
.Sp
.Vb 1
\&  $schema\->addPrefixes(pre => \*(Aqhttp://namespace\*(Aq);
\&
\&  my $type = $schema\->findName(\*(Aqpre:name\*(Aq);
\&  print $type;   # {http://namespace}name
\&
\&  my $ns   = $schema\->findName(\*(Aqpre:\*(Aq);
\&  print $ns;     # http://namespace
\&
\&  my $type = $schema\->findName(\*(Aq{somens}name\*(Aq);
\&  print $type;   # {somens}name    [a no\-op]
.Ve
.ie n .IP "$obj\->\fBfindSchemaFile\fR($filename)" 4
.el .IP "\f(CW$obj\fR\->\fBfindSchemaFile\fR($filename)" 4
.IX Item "$obj->findSchemaFile($filename)"
.PD 0
.IP "XML::Compile::Cache\->\fBfindSchemaFile\fR($filename)" 4
.IX Item "XML::Compile::Cache->findSchemaFile($filename)"
.PD
Inherited, see \*(L"Administration\*(R" in XML::Compile
.ie n .IP "$obj\->\fBimportDefinitions\fR($xmldata, %options)" 4
.el .IP "\f(CW$obj\fR\->\fBimportDefinitions\fR($xmldata, \f(CW%options\fR)" 4
.IX Item "$obj->importDefinitions($xmldata, %options)"
Inherited, see \*(L"Administration\*(R" in XML::Compile::Schema
.ie n .IP "$obj\->\fBknownNamespace\fR($ns|PAIRS)" 4
.el .IP "\f(CW$obj\fR\->\fBknownNamespace\fR($ns|PAIRS)" 4
.IX Item "$obj->knownNamespace($ns|PAIRS)"
.PD 0
.IP "XML::Compile::Cache\->\fBknownNamespace\fR($ns|PAIRS)" 4
.IX Item "XML::Compile::Cache->knownNamespace($ns|PAIRS)"
.PD
Inherited, see \*(L"Administration\*(R" in XML::Compile
.ie n .IP "$obj\->\fBnamespaces\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBnamespaces\fR()" 4
.IX Item "$obj->namespaces()"
Inherited, see \*(L"Administration\*(R" in XML::Compile::Schema
.ie n .IP "$obj\->\fBprintIndex\fR( [$fh], %options )" 4
.el .IP "\f(CW$obj\fR\->\fBprintIndex\fR( [$fh], \f(CW%options\fR )" 4
.IX Item "$obj->printIndex( [$fh], %options )"
.Vb 2
\& \-Option       \-\-Default
\&  show_declared  <true>
.Ve
.RS 4
.IP "show_declared => \s-1BOOLEAN\s0" 2
.IX Item "show_declared => BOOLEAN"
Add an indicator to each line, about whether readers and writers are
declare for the type.  Declared readers and writers will show flags
\&\f(CW\*(C`r\*(C'\fR and \f(CW\*(C`w\*(C'\fR respectively.  Compiled readers and writers carry a
\&\f(CW\*(C`R\*(C'\fR and/or \f(CW\*(C`W\*(C'\fR.
.RE
.RS 4
.RE
.ie n .IP "$obj\->\fBtypes\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBtypes\fR()" 4
.IX Item "$obj->types()"
Inherited, see \*(L"Administration\*(R" in XML::Compile::Schema
.ie n .IP "$obj\->\fBwalkTree\fR($node, \s-1CODE\s0)" 4
.el .IP "\f(CW$obj\fR\->\fBwalkTree\fR($node, \s-1CODE\s0)" 4
.IX Item "$obj->walkTree($node, CODE)"
Inherited, see \*(L"Administration\*(R" in XML::Compile
.SH "DETAILS"
.IX Header "DETAILS"
Extends \*(L"\s-1DETAILS\*(R"\s0 in XML::Compile::Schema.
.SH "DESCRIPTIONS"
.IX Header "DESCRIPTIONS"
\&\f(CW\*(C`XML::Compile::Cache\*(C'\fR is the smart brother of XML::Compile::Schema;
it keeps track of your compiled readers and writers, and also helps
you administer the parameters to handle compilation.  Besides, it
lat you use easy prefixes instead of full namespaces.
.PP
With \fIXML::Compile::Schema::compile()\fR (defined in the \s-1SUPER\s0 class of
this module) you can construct translators from \s-1XML\s0 to Perl and back.
These translators are code references, which are \*(L"expensive\*(R" to create,
but \*(L"cheap\*(R" in use; call them as often as you want.  This module helps
you administer them.
.PP
When the schemas grow larger, it gets harder to see which code reference
have already be created and which not. And, these code references need
compile options which you do not want to distribute over your whole
program.  Finally, in a daemon application, you do not want to create
the translators when used (which can be in every client again), but once
during the initiation of the daemon.
.PP
One of the most important contributions to the compile management, is
the addition of smart prefix handling. This means that you can use
prefixed names in stead of full types, often created with
\&\fIXML::Compile::Util::pack_type()\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of XML-Compile-Cache distribution version 1.05,
built on September 19, 2016. Website: \fIhttp://perl.overmeer.net/xml\-compile/\fR
.PP
Please post questions or ideas to the mailinglist at
\&\fIhttp://lists.scsys.co.uk/cgi\-bin/mailman/listinfo/xml\-compile\fR .
For live contact with other developers, visit the \f(CW\*(C`#xml\-compile\*(C'\fR channel
on \f(CW\*(C`irc.perl.org\*(C'\fR.
.SH "LICENSE"
.IX Header "LICENSE"
Copyrights 2008\-2016 by [Mark Overmeer]. For other contributors see ChangeLog.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See \fIhttp://www.perl.com/perl/misc/Artistic.html\fR