Interface used by Ouputhandlers to append content of data entities to a configured output stream or DOM.

Implementations may wrap the setup of a target-specific Recordmanager as well here.

Implementations are expected to receive SGML declaration details and markup definitions via their constructor or other means as needed to inform the Entitymanager about effective markup declarations from a calling environment that any serialized markup have to adhere to.

Name Description
set_external_subset_identifier Configures the system identifier that a lax template's target document type declaration must reference as external subset identifier.
write_data_entity Catenates a named data entity to an output stream or DOM node.

Member Details

set_external_subset_identifier(identifier)

Configures the system identifier that a lax template's target document type declaration must reference as external subset identifier. The supplied identifier is resolved against the current locator's identifier, and passed as resolved (either relative to CWD or as absolute identifier)

Parameters

Name Type Description
identifier string

the system identifier to set

write_data_entity(entity_pubid, entity_sysid, notation_pubid, notation_sysid, data_attributes, link_process_name, element, superdcn_pubid)

Catenates a named data entity to an output stream or DOM node.

Called whenever a data entity is inserted by a linkhandler into the output markup event stream; ie. on either a preempted #CONREF entity or a DAFE-implied entity that needs to be serialized to the main output stream, in addition to markup and content from main character data input.

In particular, if notation_pubid refers to the SGML public id, or notation_sysid refers to an SGML file/resource, this will produce SGML output from the resource. Support for SGML data entities is required; other notations may be supported in addition.

Parameters

Name Type Description
entity_pubid string

the public identifier of the entity, if any

entity_sysid string

the system identifier of the entity, if any

notation_pubid string

the public identifier of the notation of the entity

notation_sysid string

the system identifier of the notation of the entity, if any

data_attributes string

attribute specifications (as string) containing data attribute names/values, or the empty string, if no data attributes apply to the entity

link_process_name string

the name of the link process from where the entity is declared or generated, if any (potentially needed by an entity manager to access components such as notations or entities named in data attributes)

element string

the element name on which the #CONREF or DAFE-implied entity occurs; this is needed to determine/validate the document document element of a transcluded instance

superdcn_pubid string

the public identifier associated with the notation name denoted by the "superdcn" data attribute in the respective declaration set, if any