NAME

SGML::SubDocEntity - a SubDoc entity defined in an SGML or XML document

SYNOPSIS

  $name = $subdoc_entity->name;
  $data = $subdoc_entity->data;
  $system_id = $subdoc_entity->system_id;
  $public_id = $subdoc_entity->public_id;
  $generated_id = $subdoc_entity->generated_id;
  $attributes = $subdoc_entity->attributes;
  $notation = $subdoc_entity->notation;

  $subdoc_entity->iter;

  $subdoc_entity->accept($visitor, ...);

  The following are defined for type compatibilty:

  $subdoc_entity->as_string([$context, ...]);
  $subdoc_entity->accept_gi($visitor, ...);
  $subdoc_entity->children_accept($visitor, ...);
  $subdoc_entity->children_accept_gi($visitor, ...);

DESCRIPTION

An SGML::SubDocEntity contains a subdoc entity defined in a document instance. Within a grove, any entity with the same name refers to the same SGML::SubDocEntity object.

$subdoc_entity->name returns the entity name of the subdoc entity object.

$subdoc_entity->data returns the grove object of the subdoc if it has been loaded (XXX but that's not been defined yet).

$subdoc_entity->accept($visitor[, ...]) issues a call back to $visitor->visit_SGML_SubDocEntity($subdoc_entity[, ...]). See examples visitor.pl and simple-dump.pl for more information.

$subdoc_entity->as_string returns an empty string.

$subdoc_entity->accept_gi($visitor[, ...]) is implemented as a synonym for accept.

children_accept and children_accept_gi do nothing.

AUTHOR

Ken MacLeod, ken@bitsko.slc.ut.us

SEE ALSO

perl(1), SGML::Grove(3), Text::EntityMap(3), SGML::Element(3), SGML::PI(3).