NAME

SGML::Entity - an entity defined in an SGML or XML document

SYNOPSIS

  $name = $entity->name;
  $data = $entity->data;

  $entity->iter;

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

  The following are defined for type compatibilty:

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

DESCRIPTION

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

SGML::Entity objects occur in a value of an element attribute or as children of entities.

$entity->name returns the name of the Entity object.

$entity->data returns the data of the Entity object.

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

$entity->as_string returns an empty string.

$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).