Packages

class CatalogScope extends Catalog

CatalogScope is an enhancement of Catalog with the following capabilities: - parseCatalog(URL) tracks successfully parsed catalog or reliably throws IOException. - getParsedCatalogs() reports successfully parsed catalogs - entries() provides access to the catalog entries read across all catalogs successfully parsed. - localFilesScope(predicate) based on the catalog rewrite rules, finds all resolvable files that match the predicate.

See also

https://xerces.apache.org/xml-commons/components/apidocs/resolver/org/apache/xml/resolver/Catalog.html

Linear Supertypes
Catalog, AnyRef, Any
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. CatalogScope
  2. Catalog
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CatalogScope()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from CatalogScope to any2stringadd[CatalogScope] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (CatalogScope, B)
    Implicit
    This member is added by an implicit conversion from CatalogScope to ArrowAssoc[CatalogScope] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def addDelegate(arg0: CatalogEntry): Unit
    Attributes
    protected[org.apache.xml.resolver]
    Definition Classes
    Catalog
  7. def addEntry(arg0: CatalogEntry): Unit
    Definition Classes
    Catalog
  8. def addReader(arg0: String, arg1: CatalogReader): Unit
    Definition Classes
    Catalog
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  11. def copyReaders(arg0: Catalog): Unit
    Attributes
    protected[org.apache.xml.resolver]
    Definition Classes
    Catalog
  12. def encodedByte(arg0: Int): String
    Attributes
    protected[org.apache.xml.resolver]
    Definition Classes
    Catalog
  13. def ensuring(cond: (CatalogScope) ⇒ Boolean, msg: ⇒ Any): CatalogScope
    Implicit
    This member is added by an implicit conversion from CatalogScope to Ensuring[CatalogScope] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (CatalogScope) ⇒ Boolean): CatalogScope
    Implicit
    This member is added by an implicit conversion from CatalogScope to Ensuring[CatalogScope] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: ⇒ Any): CatalogScope
    Implicit
    This member is added by an implicit conversion from CatalogScope to Ensuring[CatalogScope] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): CatalogScope
    Implicit
    This member is added by an implicit conversion from CatalogScope to Ensuring[CatalogScope] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def entries(): Seq[CatalogEntry]

    Get the catalog entries read from the successfully parsed catalogs.

    Get the catalog entries read from the successfully parsed catalogs.

    returns

    catalog entries a

    See also

    https://xerces.apache.org/xml-commons/components/apidocs/resolver/org/apache/xml/resolver/CatalogEntry.html

  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  20. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. def fixSlashes(arg0: String): String
    Attributes
    protected[org.apache.xml.resolver]
    Definition Classes
    Catalog
  22. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from CatalogScope to StringFormat[CatalogScope] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  23. def getCatalogManager(): CatalogManager
    Definition Classes
    Catalog
  24. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. def getCurrentBase(): String
    Definition Classes
    Catalog
  26. def getDefaultOverride(): String
    Definition Classes
    Catalog
  27. def getParsedCatalogs(): Set[Path]

    Get the successfully parsed catalogs.

  28. def hasParsedCatalog(catFile: Path): Boolean

    Has this catalog been successfully parsed?

    Has this catalog been successfully parsed?

    catFile

    catalog

    returns

    whether this catalog url has been successfully parsed already

  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  30. def iri2file(localScopeFiles: Map[Path, (Path, String)], predicate: CatalogEntryFilePredicate): Map[String, Path]

    Converts localFileScope() to map of IRI and corresponding local file.

    Converts localFileScope() to map of IRI and corresponding local file.

    returns

    Uses the "uriStartString" from the localFileScope() results to reconstruct IRIs corresponding to catalog-resolved local files.

  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. def loadSystemCatalogs(): Unit
    Definition Classes
    Catalog
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  33. def localFileScope(predicate: CatalogEntryFilePredicate): Map[Path, (Path, String)]

    Local file paths resolvable given the org.apache.xml.resolver.CatalogEntry rules according to a predicate.

    Local file paths resolvable given the org.apache.xml.resolver.CatalogEntry rules according to a predicate.

    returns

    A map of local files to the longest "uriStartString" with which it was resolved from the corresponding "rewritePrefix" based on the predicate.

  34. def makeAbsolute(arg0: String): String
    Attributes
    protected[org.apache.xml.resolver]
    Definition Classes
    Catalog
  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. def newCatalog(): Catalog
    Attributes
    protected[org.apache.xml.resolver]
    Definition Classes
    Catalog
  37. def normalizeURI(arg0: String): String
    Attributes
    protected[org.apache.xml.resolver]
    Definition Classes
    Catalog
  38. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  40. def parseAllCatalogs(): Unit
    Definition Classes
    Catalog
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  41. def parseCatalog(url: URL): Unit

    Keeps track of successfully parsed catalog files.

    Keeps track of successfully parsed catalog files.

    url

    The URL for an absolute path to a catalog file.

    Definition Classes
    CatalogScope → Catalog
    Exceptions thrown

    java.io.IOException if the underlying library silently fails to parse a catalog.

  42. def parseCatalog(arg0: String, arg1: InputStream): Unit
    Definition Classes
    Catalog
    Annotations
    @throws( ... ) @throws( classOf[java.io.IOException] )
  43. def parseCatalog(arg0: String): Unit
    Definition Classes
    Catalog
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  44. def parseCatalogFile(arg0: String): Unit
    Attributes
    protected[org.apache.xml.resolver]
    Definition Classes
    Catalog
    Annotations
    @throws( ... ) @throws( classOf[java.io.IOException] ) @throws( ... )
  45. def parsePendingCatalogs(): Unit

    Unfortunately, there are circumstances where parsing a catalog fails silently without an exception thrown.

    Unfortunately, there are circumstances where parsing a catalog fails silently without an exception thrown. One way to detect this condition is to check whether parsePendingCatalogs() has been called during the execution of parseCatalog(URL).

    Attributes
    protected
    Definition Classes
    CatalogScope → Catalog
  46. val parsedCatalogs: HashSet[Path]
    Attributes
    protected
  47. def resolveDoctype(arg0: String, arg1: String, arg2: String): String
    Definition Classes
    Catalog
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  48. def resolveDocument(): String
    Definition Classes
    Catalog
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  49. def resolveEntity(arg0: String, arg1: String, arg2: String): String
    Definition Classes
    Catalog
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  50. def resolveLocalPublic(arg0: Int, arg1: String, arg2: String, arg3: String): String
    Attributes
    protected[org.apache.xml.resolver]
    Definition Classes
    Catalog
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  51. def resolveLocalSystem(arg0: String): String
    Attributes
    protected[org.apache.xml.resolver]
    Definition Classes
    Catalog
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  52. def resolveLocalURI(arg0: String): String
    Attributes
    protected[org.apache.xml.resolver]
    Definition Classes
    Catalog
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  53. def resolveNotation(arg0: String, arg1: String, arg2: String): String
    Definition Classes
    Catalog
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  54. def resolvePublic(arg0: String, arg1: String): String
    Definition Classes
    Catalog
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  55. def resolveSubordinateCatalogs(arg0: Int, arg1: String, arg2: String, arg3: String): String
    Attributes
    protected[org.apache.xml.resolver]
    Definition Classes
    Catalog
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  56. def resolveSystem(arg0: String): String
    Definition Classes
    Catalog
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  57. def resolveURI(arg0: String): String
    Definition Classes
    Catalog
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  58. def resolveURIWithExtension(uri: String, extension: String): Option[Path]

    Resolves a URI stripped of the trailing '/', if any, with the extension appended to a file path.

    Resolves a URI stripped of the trailing '/', if any, with the extension appended to a file path. The resolved path may or may not be an existing file.

    uri

    uri should match one of the catalog rewrite uri start prefixes to resolve to a file path.

    extension

    file extension, starting with '.'

    returns

    A resolved file path, if the uri matches a rewrite rule

  59. def setCatalogManager(arg0: CatalogManager): Unit
    Definition Classes
    Catalog
  60. def setupReaders(): Unit
    Definition Classes
    Catalog
  61. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  62. def toString(): String
    Definition Classes
    AnyRef → Any
  63. def unknownEntry(arg0: Vector): Unit
    Definition Classes
    Catalog
  64. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  65. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  66. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  67. def →[B](y: B): (CatalogScope, B)
    Implicit
    This member is added by an implicit conversion from CatalogScope to ArrowAssoc[CatalogScope] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Catalog

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from CatalogScope to any2stringadd[CatalogScope]

Inherited by implicit conversion StringFormat from CatalogScope to StringFormat[CatalogScope]

Inherited by implicit conversion Ensuring from CatalogScope to Ensuring[CatalogScope]

Inherited by implicit conversion ArrowAssoc from CatalogScope to ArrowAssoc[CatalogScope]

Enhanced Apache XML Catalog Resolver with scope capability

Ungrouped