jdk7u.jaxp.xml.external.stream

Class XMLEntityStorage

java.lang.Object

jdk7u.jaxp.xml.external.stream.XMLEntityStorage

public class XMLEntityStorage
extends Object

Author:

K.Venugopal SUN Microsystems, Neeraj Bajaj SUN Microsystems, Andy Clark, IBM

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ERROR_REPORTER Property identifier: error reporter.
protected Entity.ScannedEntity	fCurrentEntity
protected Hashtable	fEntities Entities.
protected XMLErrorReporter	fErrorReporter Error reporter.
protected boolean	fInExternalSubset
protected PropertyManager	fPropertyManager
protected boolean	fWarnDuplicateEntityDef warn on duplicate Entity declaration.
protected static String	WARN_ON_DUPLICATE_ENTITYDEF Feature identifier: warn on duplicate EntityDef

Constructor Summary

Constructors

Constructor and Description
XMLEntityStorage(PropertyManager propertyManager) Creates a new instance of XMLEntityStorage
XMLEntityStorage(XMLEntityManager entityManager) Creates a new instance of XMLEntityStorage

Method Summary

Methods

Modifier and Type	Method and Description
void	addExternalEntity(String name, String publicId, String literalSystemId, String baseSystemId) Adds an external entity declaration.
void	addInternalEntity(String name, String text) Adds an internal entity declaration.
void	addUnparsedEntity(String name, String publicId, String systemId, String baseSystemId, String notation) Adds an unparsed entity declaration.
void	endExternalSubset()
static String	expandSystemId(String systemId) Expands a system id and returns the system id as a URI, if it can be expanded.
static String	expandSystemId(String systemId, String baseSystemId) Expands a system id and returns the system id as a URI, if it can be expanded.
protected static String	fixURI(String str) Fixes a platform dependent filename to standard URI form.
Entity	getEntity(String name) Returns entity declaration.
Enumeration	getEntityKeys()
int	getEntitySize()
boolean	hasEntities()
boolean	isDeclaredEntity(String entityName) Checks whether an entity given by name is declared.
boolean	isEntityDeclInExternalSubset(String entityName) Checks whether the declaration of an entity given by name is // in the external subset.
boolean	isExternalEntity(String entityName) Checks whether an entity given by name is external.
boolean	isUnparsedEntity(String entityName) Checks whether an entity given by name is unparsed.
void	reset()
void	reset(PropertyManager propertyManager)
void	reset(XMLComponentManager componentManager) Resets the component.
void	startExternalSubset()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ERROR_REPORTER

protected static final String ERROR_REPORTER

Property identifier: error reporter.

See Also:

Constant Field Values

WARN_ON_DUPLICATE_ENTITYDEF

protected static final String WARN_ON_DUPLICATE_ENTITYDEF

Feature identifier: warn on duplicate EntityDef

See Also:

Constant Field Values

fWarnDuplicateEntityDef

protected boolean fWarnDuplicateEntityDef

warn on duplicate Entity declaration. http://apache.org/xml/features/warn-on-duplicate-entitydef

fEntities

protected Hashtable fEntities

Entities.

fCurrentEntity

protected Entity.ScannedEntity fCurrentEntity

fErrorReporter

protected XMLErrorReporter fErrorReporter

Error reporter. This property identifier is: http://apache.org/xml/properties/external/error-reporter

fPropertyManager

protected PropertyManager fPropertyManager

fInExternalSubset

protected boolean fInExternalSubset

Constructor Detail

XMLEntityStorage

public XMLEntityStorage(PropertyManager propertyManager)

Creates a new instance of XMLEntityStorage

XMLEntityStorage

public XMLEntityStorage(XMLEntityManager entityManager)

Creates a new instance of XMLEntityStorage

Method Detail

reset

public void reset(PropertyManager propertyManager)

reset

public void reset()

reset

public void reset(XMLComponentManager componentManager)
           throws XMLConfigurationException

Resets the component. The component can query the component manager about any features and properties that affect the operation of the component.

Parameters:

componentManager - The component manager.

Throws:

SAXException - Thrown by component on initialization error. For example, if a feature or property is required for the operation of the component, the component manager may throw a SAXNotRecognizedException or a SAXNotSupportedException.

XMLConfigurationException

getEntity

public Entity getEntity(String name)

Returns entity declaration.

Parameters:

name - The name of the entity.

See Also:

SymbolTable

hasEntities

public boolean hasEntities()

getEntitySize

public int getEntitySize()

getEntityKeys

public Enumeration getEntityKeys()

addInternalEntity

public void addInternalEntity(String name,
                     String text)

Adds an internal entity declaration.

Note: This method ignores subsequent entity declarations.

Note: The name should be a unique symbol. The SymbolTable can be used for this purpose.

Parameters:

name - The name of the entity.

text - The text of the entity.

See Also:

SymbolTable

addExternalEntity

public void addExternalEntity(String name,
                     String publicId,
                     String literalSystemId,
                     String baseSystemId)

Adds an external entity declaration.

Note: This method ignores subsequent entity declarations.

Note: The name should be a unique symbol. The SymbolTable can be used for this purpose.

Parameters:

name - The name of the entity.

publicId - The public identifier of the entity.

literalSystemId - The system identifier of the entity.

baseSystemId - The base system identifier of the entity. This is the system identifier of the entity where the entity being added and is used to expand the system identifier when the system identifier is a relative URI. When null the system identifier of the first external entity on the stack is used instead.

See Also:

SymbolTable

isExternalEntity

public boolean isExternalEntity(String entityName)

Checks whether an entity given by name is external.

Parameters:

entityName - The name of the entity to check.

isEntityDeclInExternalSubset

public boolean isEntityDeclInExternalSubset(String entityName)

Checks whether the declaration of an entity given by name is // in the external subset.

Parameters:

entityName - The name of the entity to check.

addUnparsedEntity

public void addUnparsedEntity(String name,
                     String publicId,
                     String systemId,
                     String baseSystemId,
                     String notation)

Adds an unparsed entity declaration.

Note: This method ignores subsequent entity declarations.

Note: The name should be a unique symbol. The SymbolTable can be used for this purpose.

Parameters:

name - The name of the entity.

publicId - The public identifier of the entity.

systemId - The system identifier of the entity.

notation - The name of the notation.

See Also:

SymbolTable

isUnparsedEntity

public boolean isUnparsedEntity(String entityName)

Checks whether an entity given by name is unparsed.

Parameters:

entityName - The name of the entity to check.

isDeclaredEntity

public boolean isDeclaredEntity(String entityName)

Checks whether an entity given by name is declared.

Parameters:

entityName - The name of the entity to check.

expandSystemId

public static String expandSystemId(String systemId)

Expands a system id and returns the system id as a URI, if it can be expanded. A return value of null means that the identifier is already expanded. An exception thrown indicates a failure to expand the id.

Parameters:

systemId - The systemId to be expanded.

Returns:

Returns the URI string representing the expanded system identifier. A null value indicates that the given system identifier is already expanded.

expandSystemId

public static String expandSystemId(String systemId,
                    String baseSystemId)

Expands a system id and returns the system id as a URI, if it can be expanded. A return value of null means that the identifier is already expanded. An exception thrown indicates a failure to expand the id.

Parameters:

systemId - The systemId to be expanded.

Returns:

Returns the URI string representing the expanded system identifier. A null value indicates that the given system identifier is already expanded.

fixURI

protected static String fixURI(String str)

Fixes a platform dependent filename to standard URI form.

Parameters:

str - The string to fix.

Returns:

Returns the fixed URI string.

startExternalSubset

public void startExternalSubset()

endExternalSubset

public void endExternalSubset()