org.apache.xerces.impl.dtd
Class XMLDTDDescription

java.lang.Object
  org.apache.xerces.util.XMLResourceIdentifierImpl
      org.apache.xerces.impl.dtd.XMLDTDDescription

All Implemented Interfaces:

XMLDTDDescription, XMLGrammarDescription, XMLResourceIdentifier

public class XMLDTDDescription
extends XMLResourceIdentifierImpl
implements XMLDTDDescription

All information specific to DTD grammars.

Version:

$Id: XMLDTDDescription.java 699892 2008-09-28 21:08:27Z mrglavas $

Author:

Neil Graham, IBM

Field Summary

protected ArrayList	fPossibleRoots
protected String	fRootName

Fields inherited from class org.apache.xerces.util.XMLResourceIdentifierImpl

fBaseSystemId, fExpandedSystemId, fLiteralSystemId, fNamespace, fPublicId

Fields inherited from interface org.apache.xerces.xni.grammars.XMLGrammarDescription

XML_DTD, XML_SCHEMA

Constructor Summary

XMLDTDDescription(String publicId, String literalId, String baseId, String expandedId, String rootName)

XMLDTDDescription(XMLInputSource source)

XMLDTDDescription(XMLResourceIdentifier id, String rootName)

Method Summary

boolean	equals(Object desc) Compares this grammar with the given grammar.
String	getGrammarType() Return the type of this grammar.
String	getRootName() Return the root name of this DTD.
int	hashCode() Returns the hash code of this grammar Because our .equals method is so complex, we just return a very simple hash that might avoid calls to the equals method a bit...
void	setPossibleRoots(ArrayList possibleRoots) Set possible roots
void	setPossibleRoots(Vector possibleRoots) Set possible roots
void	setRootName(String rootName) Set the root name

Methods inherited from class org.apache.xerces.util.XMLResourceIdentifierImpl

clear, getBaseSystemId, getExpandedSystemId, getLiteralSystemId, getNamespace, getPublicId, setBaseSystemId, setExpandedSystemId, setLiteralSystemId, setNamespace, setPublicId, setValues, setValues, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.xerces.xni.XMLResourceIdentifier

getBaseSystemId, getExpandedSystemId, getLiteralSystemId, getNamespace, getPublicId, setBaseSystemId, setExpandedSystemId, setLiteralSystemId, setNamespace, setPublicId

Field Detail

fRootName

protected String fRootName

fPossibleRoots

protected ArrayList fPossibleRoots

Constructor Detail

XMLDTDDescription

public XMLDTDDescription(XMLResourceIdentifier id,
                         String rootName)

XMLDTDDescription

public XMLDTDDescription(String publicId,
                         String literalId,
                         String baseId,
                         String expandedId,
                         String rootName)

XMLDTDDescription

public XMLDTDDescription(XMLInputSource source)

Method Detail

getGrammarType

public String getGrammarType()

Description copied from interface: XMLGrammarDescription

Return the type of this grammar.

Specified by:

getGrammarType in interface XMLGrammarDescription

Returns:

the type of this grammar

getRootName

public String getRootName()

Description copied from interface: XMLDTDDescription

Return the root name of this DTD.

Specified by:

getRootName in interface XMLDTDDescription

Returns:

the root name of this DTD or null if root name is unknown

setRootName

public void setRootName(String rootName)

Set the root name

setPossibleRoots

public void setPossibleRoots(ArrayList possibleRoots)

Set possible roots

setPossibleRoots

public void setPossibleRoots(Vector possibleRoots)

Set possible roots

equals

public boolean equals(Object desc)

Compares this grammar with the given grammar. Currently, we compare as follows: - if grammar type not equal return false immediately - try and find a common root name: - if both have roots, use them - else if one has a root, examine other's possible root's for a match; - else try all combinations - test fExpandedSystemId and fPublicId as above

Overrides:

equals in class Object

Parameters:

desc - The description of the grammar to be compared with

Returns:

True if they are equal, else false

hashCode

public int hashCode()

Returns the hash code of this grammar Because our .equals method is so complex, we just return a very simple hash that might avoid calls to the equals method a bit...

Overrides:

hashCode in class XMLResourceIdentifierImpl

Returns:

The hash code