Module  java.xml
软件包  javax.xml.catalog

Interface Catalog



  • public interface Catalog
    目录类代表由XML Catalogs, OASIS Standard V1.1, 7 October 2005定义的实体目录。

    目录是一个XML文件,其中包含具有目录条目列表的根catalog条目。 条目也可以与一个group条目分组。 目录和组条目可以指定preferxml:base属性,该属性设置公共或系统类型的条目的优先级和基本URI来解析相对URI。

    目录可用于两种情况:

    • 使用公共或系统标识找到外部资源;
    • 找到具有URI的备用URI引用。

    对于情况1,标准定义了6个外部标识符条目:
    public, system, rewriteSystem, systemSuffix, delegatePublic, and delegateSystem

    而对于情况2,它定义了4个URI条目:
    uri, rewriteURI, uriSuffix and delegateURI

    除了上述条目类型之外,目录还可以定义nextCatalog条目以添加其他目录条目文件。

    从以下版本开始:
    9
    • 方法详细信息

      • matchSystem

        String matchSystem​(String systemId)
        尝试通过systemId在目录中找到匹配的条目。

        该方法搜索当前目录中的系统类型条目,包括system, rewriteSystem, systemSuffix, delegateSystemgroup条目,以便找到匹配项。

        分辨率遵循以下步骤:

        • 如果匹配system项存在,则立即返回。
        • 如果多个rewriteSystem条目匹配,则返回具有最长归一化systemIdStartString值的匹配条目。
        • 如果多个systemSuffix条目匹配,则返回具有最长归一化systemIdSuffix值的匹配条目。
        • 如果不止一个delegateSystem项匹配,最长匹配的匹配项systemIdStartString返回值。
        参数
        systemId - 要匹配的实体的系统标识符
        结果
        如果找到映射的URI字符串,否则为空
      • matchPublic

        String matchPublic​(String publicId)
        尝试通过publicId在目录中找到匹配的条目。 该方法搜索当前目录中的公共类型条目,包括public, delegatePublicgroup条目,以便找到匹配项。

        请参阅有关描述Feature PREFER in the table Catalog FeaturesCatalogFeatures 只有当preferpublic和没有找到system条目时,才会考虑公开条目。

        分辨率遵循以下步骤:

        • 如果找到匹配的public条目,则会立即返回。
        • 如果一个delegatePublic条目匹配,则返回匹配条目最匹配的值为publicIdStartString
        参数
        publicId - 要匹配的实体的公共标识符
        结果
        如果找到映射的URI字符串,否则为空
        另请参见:
        CatalogFeatures.Feature
      • matchURI

        String matchURI​(String uri)
        尝试通过uri元素在目录中找到匹配的条目。

        该方法搜索uri类型条目,包括当前目录中的uri, rewriteURI, uriSuffix, delegateURIgroup条目,以便找到匹配项。

        分辨率遵循以下步骤:

        • 如果找到匹配的uri条目,则会立即返回。
        • 如果多个rewriteURI条目匹配,则返回具有最长归一化uriStartString值的匹配条目。
        • 如果不止一个uriSuffix条目匹配,最长的归一化的匹配项uriSuffix返回值。
        • 如果不止一个delegatePublic项匹配,最长匹配的匹配项uriStartString返回值。
        参数
        uri - 要匹配的实体的URI引用
        结果
        如果找到映射的URI字符串,否则为空
      • catalogs

        Stream<Catalog> catalogs​()
        返回使用指定的替代目录顺序流nextCatalog在当前目录条目,作为不包括当前目录的目录文件的输入(即,在输入列表中的第一个),当由所述创建的目录对象CatalogManager

        返回流中的目录的顺序与相应的nextCatalog条目显示在当前目录中的顺序相同。 输入文件列表中的替代目录按照输入的顺序附加到流的末尾。

        结果
        连续的目录流