1 =head1 NAME

     2 

     3 XML::DOM::Entity - An XML ENTITY in XML::DOM

     4 

     5 =head1 DESCRIPTION

     6 

     7 XML::DOM::Entity extends L<XML::DOM::Node>.

     8 

     9 This node represents an Entity declaration, e.g.

    10 

    11  <!ENTITY % draft 'INCLUDE'>

    12 

    13  <!ENTITY hatch-pic SYSTEM "../grafix/OpenHatch.gif" NDATA gif>

    14 

    15 The first one is called a parameter entity and is referenced like this: %draft;

    16 The 2nd is a (regular) entity and is referenced like this: &hatch-pic;

    17 

    18 =head2 METHODS

    19 

    20 =over 4

    21 

    22 =item getNotationName

    23 

    24 Returns the name of the notation for the entity.

    25 

    26 I<Not Implemented> The DOM Spec says: For unparsed entities, the name of the 

    27 notation for the entity. For parsed entities, this is null.

    28 (This implementation does not support unparsed entities.)

    29 

    30 =item getSysId

    31 

    32 Returns the system id, or undef.

    33 

    34 =item getPubId

    35 

    36 Returns the public id, or undef.

    37 

    38 =back

    39 

    40 =head2 Additional methods not in the DOM Spec

    41 

    42 =over 4

    43 

    44 =item isParameterEntity

    45 

    46 Whether it is a parameter entity (%ent;) or not (&ent;)

    47 

    48 =item getValue

    49 

    50 Returns the entity value.

    51 

    52 =item getNdata

    53 

    54 Returns the NDATA declaration (for general unparsed entities), or undef.

    55 

    56 =back