.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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
..
.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
.\" ========================================================================
.\"
.IX Title "URI::NamespaceMap 3pm"
.TH URI::NamespaceMap 3pm "2019-12-11" "perl v5.30.0" "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"
URI::NamespaceMap \- Class holding a collection of namespaces
.SH "VERSION"
.IX Header "VERSION"
Version 1.10
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 11
\&  use URI::NamespaceMap;
\&  my $map = URI::NamespaceMap\->new( { xsd => \*(Aqhttp://www.w3.org/2001/XMLSchema#\*(Aq } );
\&  $map\->namespace_uri(\*(Aqxsd\*(Aq)\->as_string;
\&  my $foaf = URI::Namespace\->new( \*(Aqhttp://xmlns.com/foaf/0.1/\*(Aq );
\&  $map\->add_mapping(foaf => $foaf);
\&  $map\->add_mapping(rdf => \*(Aqhttp://www.w3.org/1999/02/22\-rdf\-syntax\-ns#\*(Aq );
\&  $map\->list_prefixes;  #  ( \*(Aqfoaf\*(Aq, \*(Aqrdf\*(Aq, \*(Aqxsd\*(Aq )
\&  $map\->foaf; # Returns URI::Namespace object
\&  while (my ($prefix, $nsURI) = $map\->each_map) {
\&         $node\->setNamespace($nsURI\->as_string, $prefix); # For use with XML::LibXML
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides an object to manage multiple namespaces for creating URI::Namespace objects and for serializing.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP """new ( [ \e%namespaces | @prefixes | @uris ] )""" 4
.el .IP "\f(CWnew ( [ \e%namespaces | @prefixes | @uris ] )\fR" 4
.IX Item "new ( [ %namespaces | @prefixes | @uris ] )"
Returns a new namespace map object. You can pass a hash reference with
mappings from local names to namespace URIs (given as string or
RDF::Trine::Node::Resource) or namespaces_map with a hashref.
.Sp
You may also pass an arrayref containing just prefixes and/or
namespace URIs, and the module will try to guess the missing part. To
use this feature, you need RDF::NS::Curated, \s-1RDF::NS\s0,
XML::CommonNS or RDF::Prefixes, or preferably all of them. With
that, you can do e.g.
.Sp
.Vb 1
\&  my $map = URI::NamespaceMap\->new( \*(Aqrdf\*(Aq, \*(Aqxsd\*(Aq, \*(Aqfoaf\*(Aq );
.Ve
.Sp
and have the correct mappings added automatically.
.ie n .IP """add_mapping ( $name => $uri )""" 4
.el .IP "\f(CWadd_mapping ( $name => $uri )\fR" 4
.IX Item "add_mapping ( $name => $uri )"
Adds a new namespace to the map. The namespace \s-1URI\s0 can be passed
as string or a URI::Namespace object.
.ie n .IP """remove_mapping ( $name )""" 4
.el .IP "\f(CWremove_mapping ( $name )\fR" 4
.IX Item "remove_mapping ( $name )"
Removes a namespace from the map given a prefix.
.ie n .IP """namespace_uri ( $name )""" 4
.el .IP "\f(CWnamespace_uri ( $name )\fR" 4
.IX Item "namespace_uri ( $name )"
Returns the URI::Namespace object (if any) associated with the given prefix.
.ie n .IP "$name" 4
.el .IP "\f(CW$name\fR" 4
.IX Item "$name"
This module creates a method for all the prefixes, so you can say e.g.
.Sp
.Vb 1
\&  $map\->foaf
.Ve
.Sp
and get a URI::Namespace object for the \s-1FOAF\s0 namespace. Since
URI::Namespace does the same for local names, you can then say e.g.
.Sp
.Vb 1
\&  $map\->foaf\->name
.Ve
.Sp
to get a full \s-1URI\s0.
.ie n .IP """list_namespaces""" 4
.el .IP "\f(CWlist_namespaces\fR" 4
.IX Item "list_namespaces"
Returns an array of URI::Namespace objects with all the namespaces.
.ie n .IP """list_prefixes""" 4
.el .IP "\f(CWlist_prefixes\fR" 4
.IX Item "list_prefixes"
Returns an array of prefixes.
.ie n .IP """each_map""" 4
.el .IP "\f(CWeach_map\fR" 4
.IX Item "each_map"
Returns an 2\-element list where the first element is a prefix and the
second is the corresponding URI::Namespace object.
.ie n .IP """guess_and_add ( @string_or_uri )""" 4
.el .IP "\f(CWguess_and_add ( @string_or_uri )\fR" 4
.IX Item "guess_and_add ( @string_or_uri )"
Like in the constructor, an array of strings can be given, and the
module will attempt to guess appropriate mappings, and add them to the
map.
.ie n .IP """uri ( $prefixed_name )""" 4
.el .IP "\f(CWuri ( $prefixed_name )\fR" 4
.IX Item "uri ( $prefixed_name )"
Returns a \s-1URI\s0 for an abbreviated string such as 'foaf:Person'.
.ie n .IP "prefix_for ""uri ($uri)""" 4
.el .IP "prefix_for \f(CWuri ($uri)\fR" 4
.IX Item "prefix_for uri ($uri)"
Returns the associated prefix (or potentially multiple prefixes, when
called in list context) for the given \s-1URI.\s0
.ie n .IP "abbreviate ""uri ($uri)""" 4
.el .IP "abbreviate \f(CWuri ($uri)\fR" 4
.IX Item "abbreviate uri ($uri)"
Complement to \*(L"namespace_uri\*(R". Returns the given \s-1URI\s0 in \f(CW\*(C`foo:bar\*(C'\fR
format or \f(CW\*(C`undef\*(C'\fR if it wasn't matched, therefore the idiom
.Sp
.Vb 1
\&    my $str = $nsmap\->abbreviate($uri_node) || $uri\->as_string;
.Ve
.Sp
may be useful for certain serialization tasks.
.SH "WARNING"
.IX Header "WARNING"
Avoid using the names 'can', 'isa', '\s-1VERSION\s0', and '\s-1DOES\s0' as namespace
prefix, because these names are defined as method for every Perl
object by default. The method names 'new' and 'uri' are also
forbidden. Names of methods of Moose::Object must also be avoided.
.PP
Using them will result in an error.
.SH "AUTHORS"
.IX Header "AUTHORS"
Chris Prather, \f(CW\*(C`<chris@prather.org>\*(C'\fR
Kjetil Kjernsmo, \f(CW\*(C`<kjetilk@cpan.org>\*(C'\fR
Gregory Todd Williams, \f(CW\*(C`<gwilliams@cpan.org>\*(C'\fR
Toby Inkster, \f(CW\*(C`<tobyink@cpan.org>\*(C'\fR
.SH "CONTRIBUTORS"
.IX Header "CONTRIBUTORS"
Dorian Taylor
Paul Williams
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs using github <https://github.com/kjetilk/URI-NamespaceMap/issues>
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\&    perldoc URI::NamespaceMap
.Ve
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2012,2013,2014,2015,2016,2017,2018,2019 Gregory Todd Williams, Chris Prather and Kjetil Kjernsmo
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.