read-entity

function

Library: Markup utilities (OMMARKUPUTILITIES)
Import : ommarkuputilities.xmd

Returns: the unparsed entity text

Declaration

export dynamic string source function
   read-entity  via value entity-resolver resolver
               from value string          uri

Purpose

The string source function read-entity is used to read the entity value from its resolved URI. This function is usually applied to the URI returned by map-external-identifier, and it attempts to apply map-uri to it as well. If the entity value cannot be read, read-entity throws resolution-failure.

The read-entity function is dynamic. Its default implementation on the base entity-resolver type works only with the local files, while its overriding on oasis.catalog-type accepts FTP and HTTP URIs as well. The function is used by external-entity-resolver, external-entities-resolved, and parse-entity, so any overriding of read-entity will affect them as well.

Related Topics

Other Library Functions