|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectatg.xml.service.DocumentCacheKey
public class DocumentCacheKey
A DocumentCacheKey can be used to index DocumentCacheValue objects in a Cache.
There are three ways of specifying a Document Cache key:
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
Constructor Summary | |
---|---|
DocumentCacheKey(RepositoryItem pItem,
java.lang.String pPropertyName,
long pContentTimeStamp,
boolean pValidate,
boolean pLoadDTD)
Construct a document cache key using an atg.repository.RepositoryItem and the XML content property to be transformed into a W3C Document Object Model object. |
|
DocumentCacheKey(java.lang.String pAbsoluteUrl,
java.lang.String pAbsoluteFilePath,
boolean pValidate)
Construct a document cache key. |
|
DocumentCacheKey(java.lang.String pAbsoluteUrl,
java.lang.String pAbsoluteFilePath,
boolean pValidate,
boolean pLoadDTD)
Construct a document cache key. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
DocumentCacheKey override of equals method |
java.lang.String |
getAbsoluteFilePath()
Return the absoluteFilePath property of this key. |
java.lang.String |
getAbsoluteURL()
Return the absoluteURL property of this key. |
java.lang.String |
getBaseURI()
Get a base URI from a cache key. |
org.xml.sax.ErrorHandler |
getErrorHandler()
Get the SAX ErrorHandler that is used to handle parsing errors produced for this key. |
java.lang.String |
getPropertyName()
Get the PropertyName property |
RepositoryItem |
getRepositoryItem()
Get the RepositoryItem property |
long |
getTimeStamp()
The time at when the content in the repository was last modified. |
int |
hashCode()
DocumentCacheKey override of the hashcode method. |
boolean |
isLoadDTD()
A flag which will control whether the parser will load the DTD or not. |
boolean |
isValidate()
Will XML validation be used when parsing the document? |
void |
setErrorHandler(org.xml.sax.ErrorHandler pErrorHandler)
Set a SAX ErrorHandler to handle parsing errors produced for this key. |
java.lang.String |
toString()
DocumentCacheKey override of the toString() method. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public DocumentCacheKey(RepositoryItem pItem, java.lang.String pPropertyName, long pContentTimeStamp, boolean pValidate, boolean pLoadDTD)
pItem
- A RepositoryItempPropertyName
- The property on the repository item where the XML content is store.pContentTimeStamp
- When the RepositoryItem was last updatedpValidate
- Whether validation will be used by the XML parserpLoadDTD
- Whether the XML parser will load the DTD or not.public DocumentCacheKey(java.lang.String pAbsoluteUrl, java.lang.String pAbsoluteFilePath, boolean pValidate)
pAbsoluteUrl
- An absolute URLpAbsoluteFilePath
- An OS specific file absolute file pathpValidate
- Whether validation will be used by the XML parserpublic DocumentCacheKey(java.lang.String pAbsoluteUrl, java.lang.String pAbsoluteFilePath, boolean pValidate, boolean pLoadDTD)
pAbsoluteUrl
- An absolute URLpAbsoluteFilePath
- An OS specific file absolute file pathpValidate
- Whether validation will be used by the XML parserpLoadDTD
- Whether the XML parser will load the DTD or not.Method Detail |
---|
public java.lang.String getAbsoluteURL()
public java.lang.String getAbsoluteFilePath()
public boolean isValidate()
public boolean isLoadDTD()
public RepositoryItem getRepositoryItem()
public java.lang.String getPropertyName()
public long getTimeStamp()
public void setErrorHandler(org.xml.sax.ErrorHandler pErrorHandler)
public org.xml.sax.ErrorHandler getErrorHandler()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.String getBaseURI()
file://
,
otherwise the absolute URL is returned.
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |