Package com.itextpdf.xmp.impl

Class XMPSchemaRegistryImpl

  • All Implemented Interfaces:
    XMPConst, XMPSchemaRegistry
    public final class XMPSchemaRegistryImpl
extends java.lang.Object
implements XMPSchemaRegistry, XMPConst
    The schema registry handles the namespaces, aliases and global options for the XMP Toolkit. There is only one single instance used by the toolkit.
    Since:
    27.01.2006

    • Field Detail

      • namespaceToPrefixMap

        private java.util.Map namespaceToPrefixMap
        a map from a namespace URI to its registered prefix

      • prefixToNamespaceMap

        private java.util.Map prefixToNamespaceMap
        a map from a prefix to the associated namespace URI

      • aliasMap

        private java.util.Map aliasMap
        a map of all registered aliases. The map is a relationship from a qname to an XMPAliasInfo-object.

      • p

        private java.util.regex.Pattern p
        The pattern that must not be contained in simple properties

    • Constructor Detail

      • XMPSchemaRegistryImpl

        public XMPSchemaRegistryImpl()
        Performs the initialisation of the registry with the default namespaces, aliases and global options.

    • Method Detail

      • registerNamespace

        public java.lang.String registerNamespace​(java.lang.String namespaceURI,
                                          java.lang.String suggestedPrefix)
                                   throws XMPException
        Description copied from interface: XMPSchemaRegistry
        Register a namespace URI with a suggested prefix. It is not an error if the URI is already registered, no matter what the prefix is. If the URI is not registered but the suggested prefix is in use, a unique prefix is created from the suggested one. The actual registeed prefix is always returned. The function result tells if the registered prefix is the suggested one.

        Note: No checking is presently done on either the URI or the prefix.

        Specified by:
        registerNamespace in interface XMPSchemaRegistry
        Parameters:
        namespaceURI - The URI for the namespace. Must be a valid XML URI.
        suggestedPrefix - The suggested prefix to be used if the URI is not yet registered. Must be a valid XML name.
        Returns:
        Returns the registered prefix for this URI, is equal to the suggestedPrefix if the namespace hasn't been registered before, otherwise the existing prefix.
        Throws:
        XMPException - If the parameters are not accordingly set
        See Also:
        XMPSchemaRegistry.registerNamespace(String, String)

      • deleteNamespace

        public void deleteNamespace​(java.lang.String namespaceURI)
        Description copied from interface: XMPSchemaRegistry
        Deletes a namespace from the registry.

        Does nothing if the URI is not registered, or if the namespaceURI parameter is null or the empty string.

        Note: Not yet implemented.

        Specified by:
        deleteNamespace in interface XMPSchemaRegistry
        Parameters:
        namespaceURI - The URI for the namespace.
        See Also:
        XMPSchemaRegistry.deleteNamespace(String)

      • getNamespacePrefix

        public java.lang.String getNamespacePrefix​(java.lang.String namespaceURI)
        Description copied from interface: XMPSchemaRegistry
        Obtain the prefix for a registered namespace URI.

        It is not an error if the namespace URI is not registered.

        Specified by:
        getNamespacePrefix in interface XMPSchemaRegistry
        Parameters:
        namespaceURI - The URI for the namespace. Must not be null or the empty string.
        Returns:
        Returns the prefix registered for this namespace URI or null.
        See Also:
        XMPSchemaRegistry.getNamespacePrefix(String)

      • getNamespaceURI

        public java.lang.String getNamespaceURI​(java.lang.String namespacePrefix)
        Description copied from interface: XMPSchemaRegistry
        Obtain the URI for a registered namespace prefix.

        It is not an error if the namespace prefix is not registered.

        Specified by:
        getNamespaceURI in interface XMPSchemaRegistry
        Parameters:
        namespacePrefix - The prefix for the namespace. Must not be null or the empty string.
        Returns:
        Returns the URI registered for this prefix or null.
        See Also:
        XMPSchemaRegistry.getNamespaceURI(String)

      • registerStandardNamespaces

        private void registerStandardNamespaces()
                                 throws XMPException
        Register the standard namespaces of schemas and types that are included in the XMP Specification and some other Adobe private namespaces. Note: This method is not lock because only called by the constructor.
        Throws:
        XMPException - Forwards processing exceptions

      • resolveAlias

        public XMPAliasInfo resolveAlias​(java.lang.String aliasNS,
                                 java.lang.String aliasProp)
        Description copied from interface: XMPSchemaRegistry
        Determines if a name is an alias, and what it is aliased to.
        Specified by:
        resolveAlias in interface XMPSchemaRegistry
        Parameters:
        aliasNS - The namespace URI of the alias. Must not be null or the empty string.
        aliasProp - The name of the alias. May be an arbitrary path expression path, must not be null or the empty string.
        Returns:
        Returns the XMPAliasInfo for the given alias namespace and property or null if there is no such alias.
        See Also:
        XMPSchemaRegistry.resolveAlias(String, String)

      • findAliases

        public XMPAliasInfo[] findAliases​(java.lang.String aliasNS)
        Description copied from interface: XMPSchemaRegistry
        Collects all aliases that are contained in the provided namespace. If nothing is found, an empty array is returned.
        Specified by:
        findAliases in interface XMPSchemaRegistry
        Parameters:
        aliasNS - a schema namespace URI
        Returns:
        Returns all alias infos from aliases that are contained in the provided namespace.
        See Also:
        XMPSchemaRegistry.findAliases(String)

      • registerAlias

        void registerAlias​(java.lang.String aliasNS,
                   java.lang.String aliasProp,
                   java.lang.String actualNS,
                   java.lang.String actualProp,
                   AliasOptions aliasForm)
            throws XMPException
        Associates an alias name with an actual name.

        Define a alias mapping from one namespace/property to another. Both property names must be simple names. An alias can be a direct mapping, where the alias and actual have the same data type. It is also possible to map a simple alias to an item in an array. This can either be to the first item in the array, or to the 'x-default' item in an alt-text array. Multiple alias names may map to the same actual, as long as the forms match. It is a no-op to reregister an alias in an identical fashion. Note: This method is not locking because only called by registerStandardAliases which is only called by the constructor. Note2: The method is only package-private so that it can be tested with unittests

        Parameters:
        aliasNS - The namespace URI for the alias. Must not be null or the empty string.
        aliasProp - The name of the alias. Must be a simple name, not null or the empty string and not a general path expression.
        actualNS - The namespace URI for the actual. Must not be null or the empty string.
        actualProp - The name of the actual. Must be a simple name, not null or the empty string and not a general path expression.
        aliasForm - Provides options for aliases for simple aliases to array items. This is needed to know what kind of array to create if set for the first time via the simple alias. Pass XMP_NoOptions, the default value, for all direct aliases regardless of whether the actual data type is an array or not (see AliasOptions).
        Throws:
        XMPException - for inconsistant aliases.

      • registerStandardAliases

        private void registerStandardAliases()
                              throws XMPException
        Register the standard aliases. Note: This method is not lock because only called by the constructor.
        Throws:
        XMPException - If the registrations of at least one alias fails.