Skip Headers

Oracle® XML API Reference
10g Release 1 (10.1)
Part No. B10789-01
  Go To Table Of Contents
Contents

Previous Next  

Entity Interface

Table 4-6 summarizes the methods of available through the Entity interface.

Table 4-6 Summary of Entity Methods; DOM Package

Function Summary
XmlDomGetEntityNotation
Get entity's notation.
XmlDomGetEntityPubID
Get entity's public ID.
XmlDomGetEntitySysID
Get entity's system ID.
XmlDomGetEntityType
Get entity's type.


XmlDomGetEntityNotation

For unparsed entities, returns the name of its notation (in the data encoding). For parsed entities and other node types, returns NULL.


Syntax
oratext* XmlDomGetEntityNotation(
   xmlctx *xctx,
   xmlentnode *ent)

Parameter In/Out Description
xctx
IN
XML context
ent
IN
entity node


Returns

(oratext *) entity's notation [data encoding; may be NULL]


XmlDomGetEntityPubID

Returns an entity's public identifier (in the data encoding). If the node is not an entity, or has no defined public ID, returns NULL.


Syntax
oratext* XmlDomGetEntityPubID(
   xmlctx *xctx,
   xmlentnode *ent)

Parameter In/Out Description
xctx
IN
XML context
ent
IN
entity node


Returns

(oratext *) entity's public identifier [data encoding; may be NULL]


XmlDomGetEntitySysID

Returns an entity's system identifier (in the data encoding). If the node is not an entity, or has no defined system ID, returns NULL.


Syntax
oratext* XmlDomGetEntitySysID(
   xmlctx *xctx, 
   xmlentnode *ent)

Parameter In/Out Description
xctx
IN
XML context
ent
IN
entity node


Returns

(oratext *) entity's system identifier [data encoding; may be NULL]


XmlDomGetEntityType

Returns a boolean for an entity describing whether it is general (TRUE) or parameter (FALSE).


Syntax
boolean XmlDomGetEntityType(
   xmlctx *xctx,
   xmlentnode *ent)

Parameter In/Out Description
xctx
IN
XML context
ent
IN
entity node


Returns

(boolean) TRUE for general entity, FALSE for parameter entity