org.exolab.castor.xml.dtd.GeneralEntity Class Reference

List of all members.

Public Member Functions
	GeneralEntity ()
	GeneralEntity (DTDdocument document, String name)
String	getName ()
DTDdocument	getDocument ()
void	setValue (String value)
boolean	isInternal ()
String	getValue ()
void	setExternalPublic (String pubId, String sysId)
boolean	isExternalPublic ()
void	setExternalSystem (String sysId)
boolean	isExternalSystem ()
String	getSysIdentifier ()
String	getPubIdentifier ()
void	setNDATA (String notationName)
boolean	isExternalUnparsed ()
String	getNotation ()

---

Detailed Description

Implementation of DTD General Entity declaration specification.

Author:

Alexander Totok

Version:

Revision:

1.1.1.1

Date:

2003/03/03 07:09:20

---

Constructor & Destructor Documentation

org.exolab.castor.xml.dtd.GeneralEntity.GeneralEntity

(

)

Default constructor.

org.exolab.castor.xml.dtd.GeneralEntity.GeneralEntity	(	DTDdocument	document,
		String	name
	)

Constructor, setting name and owning DTD document of the general entity.

Parameters:

	document	must not be null.
	name	must not be null or equal to empty String.

---

Member Function Documentation

DTDdocument org.exolab.castor.xml.dtd.GeneralEntity.getDocument

(

)

Return DTD document owning this General Entity declaration.

String org.exolab.castor.xml.dtd.GeneralEntity.getName

(

)

Returns the name of the general entity.

Referenced by org.exolab.castor.xml.dtd.DTDdocument.addGeneralEntity().

String org.exolab.castor.xml.dtd.GeneralEntity.getNotation

(

)

Returns name of associated notation, if external entity, null otherwise.

References org.exolab.castor.xml.dtd.GeneralEntity.isExternalPublic(), and org.exolab.castor.xml.dtd.GeneralEntity.isExternalSystem().

String org.exolab.castor.xml.dtd.GeneralEntity.getPubIdentifier

(

)

Returns public identifier, if EXTERNAL_PUBLIC entity, null otherwise.

References org.exolab.castor.xml.dtd.GeneralEntity.isExternalPublic().

String org.exolab.castor.xml.dtd.GeneralEntity.getSysIdentifier

(

)

Returns system identifier, if EXTERNAL_PUBLIC or EXTERNAL_SYSTEM entity, null otherwise.

References org.exolab.castor.xml.dtd.GeneralEntity.isExternalPublic(), and org.exolab.castor.xml.dtd.GeneralEntity.isExternalSystem().

String org.exolab.castor.xml.dtd.GeneralEntity.getValue

(

)

Returns the value of the entity (replacement text) if internal entity, null otherwise.

References org.exolab.castor.xml.dtd.GeneralEntity.isInternal().

boolean org.exolab.castor.xml.dtd.GeneralEntity.isExternalPublic

(

)

True if EXTERNAL_PUBLIC entity, false otherwise.

Referenced by org.exolab.castor.xml.dtd.GeneralEntity.getNotation(), org.exolab.castor.xml.dtd.GeneralEntity.getPubIdentifier(), org.exolab.castor.xml.dtd.GeneralEntity.getSysIdentifier(), and org.exolab.castor.xml.dtd.GeneralEntity.isExternalUnparsed().

boolean org.exolab.castor.xml.dtd.GeneralEntity.isExternalSystem

(

)

True if EXTERNAL_SYSTEM entity, false otherwise.

Referenced by org.exolab.castor.xml.dtd.GeneralEntity.getNotation(), org.exolab.castor.xml.dtd.GeneralEntity.getSysIdentifier(), and org.exolab.castor.xml.dtd.GeneralEntity.isExternalUnparsed().

boolean org.exolab.castor.xml.dtd.GeneralEntity.isExternalUnparsed

(

)

True if external unparsed entity, that is if external and associated notation name is specified, false otherwise.

References org.exolab.castor.xml.dtd.GeneralEntity.isExternalPublic(), and org.exolab.castor.xml.dtd.GeneralEntity.isExternalSystem().

boolean org.exolab.castor.xml.dtd.GeneralEntity.isInternal

(

)

True if internal entity, false otherwise.

Referenced by org.exolab.castor.xml.dtd.GeneralEntity.getValue().

void org.exolab.castor.xml.dtd.GeneralEntity.setExternalPublic	(	String	pubId,
		String	sysId
	)

Sets the general entity to EXTERNAL_PUBLIC.

Parameters:

	pubId	public identifier - must not be null.
	sysId	system identifier - must not be null.

Referenced by org.exolab.castor.xml.dtd.parser.DTDParser.GEntityDecl().

void org.exolab.castor.xml.dtd.GeneralEntity.setExternalSystem

(

String

sysId

)

Sets the general entity to EXTERNAL_SYSTEM.

Parameters:

sysId

system identifier - must not be null.

Referenced by org.exolab.castor.xml.dtd.parser.DTDParser.GEntityDecl().

void org.exolab.castor.xml.dtd.GeneralEntity.setNDATA

(

String

notationName

)

Sets the associated notation.

Parameters:

notationName

- must not be null or equal to empty String.

Referenced by org.exolab.castor.xml.dtd.parser.DTDParser.GEntityDecl().

void org.exolab.castor.xml.dtd.GeneralEntity.setValue

(

String

value

)

Sets the value (replacement text) of the general entity, making it internal parsed entity.

Parameters:

value

must not be null.

Referenced by org.exolab.castor.xml.dtd.parser.DTDParser.GEntityDecl().

---

The documentation for this class was generated from the following file:

• GeneralEntity.java