com.jaxfront.core.dom
Class FingerPrint

java.lang.Object
  com.jaxfront.core.dom.FingerPrint

public class FingerPrint
extends java.lang.Object

FingerPrint information of a XUI document. Holds xui version, an application version, creation time and any included xui documents.

Field Summary

long	_dbLoadTimeStamp
static java.lang.String	JAXFRONT_PI
static java.lang.String	JAXFRONT_PI_APP_VERSION
static java.lang.String	JAXFRONT_PI_CONTROLLER
static java.lang.String	JAXFRONT_PI_CREATED
static java.lang.String	JAXFRONT_PI_CREATED_USER
static java.lang.String	JAXFRONT_PI_GROUP_ID
static java.lang.String	JAXFRONT_PI_ID
static java.lang.String	JAXFRONT_PI_INCLUDE
static java.lang.String	JAXFRONT_PI_INCLUDE_PDF
static java.lang.String	JAXFRONT_PI_LASTUPDATE
static java.lang.String	JAXFRONT_PI_LASTUPDATE_USER
static java.lang.String	JAXFRONT_PI_MANDANT_ID
static java.lang.String	JAXFRONT_PI_OWNER
static java.lang.String	JAXFRONT_PI_PID
static java.lang.String	JAXFRONT_PI_STATUS
static java.lang.String	JAXFRONT_PI_TIME
static java.lang.String	JAXFRONT_PI_VERSION
static java.lang.String	JAXFRONT_PI_XML
static java.lang.String	JAXFRONT_PI_XSD
static java.lang.String	JAXFRONT_PI_XUI
static java.lang.String	JAXFRONT_PI_XUI_NS_MAPPING

Constructor Summary

FingerPrint(Document jaxDOM, org.w3c.dom.Document dom, org.w3c.dom.ls.LSInput xsdInput, org.w3c.dom.ls.LSInput xuiInput)

FingerPrint(Document jaxDOM, org.w3c.dom.Document dom, java.net.URL xsdURL, org.w3c.dom.ls.LSInput xuiInput)

FingerPrint(Document jaxDOM, org.w3c.dom.Document dom, java.net.URL xsdURL, java.net.URL xuiURL)
Creates a fingerprint based on a XUI url.

Method Summary

void	addIncludedFingerPrint(FingerPrint fingerPrint) Adds an nested fingerprint.
void	checkVersionNo() Checks the version number in the xui document with the current running JAXFront core engine xui version.
java.lang.String	getAppVersionNo() Returns the application version no.
java.lang.String	getController()
long	getDBLoadTimeStamp()
org.apache.xerces.xni.parser.XMLEntityResolver	getEntityResolver()
java.util.Vector	getIncludedFingerPrints() Returns the nested fingerprints if any otherwise return an empty Vector.
java.lang.String	getIncludedPDFXUI() Returns the included PDF XUI name.
java.util.Vector	getIncludes() Returns a list of included xui file names.
Document	getJAXDOM()
java.lang.String	getLastLoadedLanguage()
java.lang.String[]	getNLSReadingSequence(java.lang.String defaultLang) Returns the nls reading sequence.
java.lang.String	getPID() Returns the persistent id.
java.lang.String	getProcessingInstruction(java.lang.String key)
java.util.Hashtable	getProcessingInstructions()
java.lang.String	getTimeCreated() Returns the time this XUI has been last updated.
java.lang.String	getVersionNo() Returns the version number of this fingerprint.
java.lang.String	getXmlLocation()
org.w3c.dom.ls.LSInput	getXSDInput()
java.lang.String	getXSDJAXContent()
java.lang.String	getXsdLocation()
java.net.URL	getXSDURL()
org.w3c.dom.ls.LSInput	getXUIInput()
java.lang.String	getXUIJAXContent()
java.lang.String	getXuiLocation()
java.util.Hashtable	getXUINamespaceMapping() Returns the nested fingerprints if any otherwise return an empty Vector.
java.lang.String	getXUINamespaceMapping(java.lang.String namespace)
java.net.URL	getXUIURL()
boolean	hasIncludes() Indicates if this fingerprint includes other xui files.
java.lang.Object	putProcessingInstructions(java.lang.String key, java.lang.String value)
java.lang.Object	putProcessingInstructions(java.lang.String key, java.lang.String value, CodeSetEntry codeSetEntry)
java.lang.String	putXUINamespaceMapping(java.lang.String namespace, java.lang.String prefix)
void	refresh(FingerPrint xuiFingerprint)
void	removeProcessingInstruction(java.lang.String key)
java.lang.StringBuffer	serialize(Document jaxDom) Serializes the fingerprint to a StringBuffer.
void	setAppVersionNo(java.lang.String versionNo) Sets the application version of this fingerprint.
void	setDBLoadTimeStamp(long loadTimeStamp)
void	setEntityResolver(org.apache.xerces.xni.parser.XMLEntityResolver resolver)
void	setIncludedPDFXUI(java.lang.String name) Sets the included pdf xui name.
void	setLastLoadedLanguage(java.lang.String currentLang)
void	setNLSReadingSequence(java.lang.String[] langSeq) Set the nls reading sequence.
void	setPID(java.lang.String pid) Sets the PID of this document.
void	setSerializeJAXFrontPI(boolean serializeJAXFrontPI)
void	setXmlLocation(java.lang.String xmlLocation)
void	setXSDInput(org.w3c.dom.ls.LSInput input)
void	setXSDJAXContent(java.lang.String content)
void	setXsdLocation(java.lang.String xsdLocation)
void	setXUIInput(org.w3c.dom.ls.LSInput input)
void	setXUIJAXContent(java.lang.String content)
void	setXuiLocation(java.lang.String xuiLocation)
void	setXUINamespaceMapping(java.util.Hashtable mapping)
void	setXuiURL(java.net.URL xuiURL)
void	update(java.lang.String jaxfrontPI)

Methods inherited from class java.lang.Object

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

Field Detail

_dbLoadTimeStamp

public long _dbLoadTimeStamp

JAXFRONT_PI

public static final java.lang.String JAXFRONT_PI

See Also:

Constant Field Values

JAXFRONT_PI_APP_VERSION

public static final java.lang.String JAXFRONT_PI_APP_VERSION

See Also:

Constant Field Values

JAXFRONT_PI_CONTROLLER

public static final java.lang.String JAXFRONT_PI_CONTROLLER

See Also:

Constant Field Values

JAXFRONT_PI_CREATED

public static final java.lang.String JAXFRONT_PI_CREATED

See Also:

Constant Field Values

JAXFRONT_PI_CREATED_USER

public static final java.lang.String JAXFRONT_PI_CREATED_USER

See Also:

Constant Field Values

JAXFRONT_PI_GROUP_ID

public static final java.lang.String JAXFRONT_PI_GROUP_ID

See Also:

Constant Field Values

JAXFRONT_PI_ID

public static final java.lang.String JAXFRONT_PI_ID

See Also:

Constant Field Values

JAXFRONT_PI_INCLUDE

public static final java.lang.String JAXFRONT_PI_INCLUDE

See Also:

Constant Field Values

JAXFRONT_PI_INCLUDE_PDF

public static final java.lang.String JAXFRONT_PI_INCLUDE_PDF

See Also:

Constant Field Values

JAXFRONT_PI_LASTUPDATE

public static final java.lang.String JAXFRONT_PI_LASTUPDATE

See Also:

Constant Field Values

JAXFRONT_PI_LASTUPDATE_USER

public static final java.lang.String JAXFRONT_PI_LASTUPDATE_USER

See Also:

Constant Field Values

JAXFRONT_PI_MANDANT_ID

public static final java.lang.String JAXFRONT_PI_MANDANT_ID

See Also:

Constant Field Values

JAXFRONT_PI_OWNER

public static final java.lang.String JAXFRONT_PI_OWNER

See Also:

Constant Field Values

JAXFRONT_PI_PID

public static final java.lang.String JAXFRONT_PI_PID

See Also:

Constant Field Values

JAXFRONT_PI_STATUS

public static final java.lang.String JAXFRONT_PI_STATUS

See Also:

Constant Field Values

JAXFRONT_PI_TIME

public static final java.lang.String JAXFRONT_PI_TIME

See Also:

Constant Field Values

JAXFRONT_PI_VERSION

public static final java.lang.String JAXFRONT_PI_VERSION

See Also:

Constant Field Values

JAXFRONT_PI_XML

public static final java.lang.String JAXFRONT_PI_XML

See Also:

Constant Field Values

JAXFRONT_PI_XSD

public static final java.lang.String JAXFRONT_PI_XSD

See Also:

Constant Field Values

JAXFRONT_PI_XUI

public static final java.lang.String JAXFRONT_PI_XUI

See Also:

Constant Field Values

JAXFRONT_PI_XUI_NS_MAPPING

public static final java.lang.String JAXFRONT_PI_XUI_NS_MAPPING

See Also:

Constant Field Values

Constructor Detail

FingerPrint

public FingerPrint(Document jaxDOM,
                   org.w3c.dom.Document dom,
                   org.w3c.dom.ls.LSInput xsdInput,
                   org.w3c.dom.ls.LSInput xuiInput)

FingerPrint

public FingerPrint(Document jaxDOM,
                   org.w3c.dom.Document dom,
                   java.net.URL xsdURL,
                   org.w3c.dom.ls.LSInput xuiInput)

FingerPrint

public FingerPrint(Document jaxDOM,
                   org.w3c.dom.Document dom,
                   java.net.URL xsdURL,
                   java.net.URL xuiURL)

Creates a fingerprint based on a XUI url.

Parameters:

xuiURL - location of the xui document.

Method Detail

addIncludedFingerPrint

public void addIncludedFingerPrint(FingerPrint fingerPrint)

Adds an nested fingerprint.

Parameters:

fingerPrint - to add to my list of includes

checkVersionNo

public void checkVersionNo()
                    throws DocumentCreationException

Checks the version number in the xui document with the current running JAXFront core engine xui version. If it does not match, an exception is thrown.

Throws:

DocumentCreationException - if xui version does not mach current core engine version

getAppVersionNo

public java.lang.String getAppVersionNo()

Returns the application version no.

getController

public java.lang.String getController()

getDBLoadTimeStamp

public long getDBLoadTimeStamp()

getEntityResolver

public org.apache.xerces.xni.parser.XMLEntityResolver getEntityResolver()

getIncludedFingerPrints

public java.util.Vector getIncludedFingerPrints()

Returns the nested fingerprints if any otherwise return an empty Vector.

getIncludedPDFXUI

public java.lang.String getIncludedPDFXUI()

Returns the included PDF XUI name.

getIncludes

public java.util.Vector getIncludes()

Returns a list of included xui file names.

getJAXDOM

public Document getJAXDOM()

getLastLoadedLanguage

public java.lang.String getLastLoadedLanguage()

getNLSReadingSequence

public java.lang.String[] getNLSReadingSequence(java.lang.String defaultLang)

Returns the nls reading sequence. Lowest priority first!

Parameters:

defaultLang -

Returns:

getPID

public java.lang.String getPID()

Returns the persistent id. Returns null if the document has not been stored before.

getProcessingInstruction

public java.lang.String getProcessingInstruction(java.lang.String key)

getProcessingInstructions

public java.util.Hashtable getProcessingInstructions()

getTimeCreated

public java.lang.String getTimeCreated()

Returns the time this XUI has been last updated.

getVersionNo

public java.lang.String getVersionNo()

Returns the version number of this fingerprint.

getXmlLocation

public java.lang.String getXmlLocation()

Returns:

Returns the xmlLocation.

getXSDInput

public org.w3c.dom.ls.LSInput getXSDInput()

getXSDJAXContent

public java.lang.String getXSDJAXContent()

getXsdLocation

public java.lang.String getXsdLocation()

Returns:

Returns the xsdLocstion.

getXSDURL

public java.net.URL getXSDURL()

getXUIInput

public org.w3c.dom.ls.LSInput getXUIInput()

getXUIJAXContent

public java.lang.String getXUIJAXContent()

getXuiLocation

public java.lang.String getXuiLocation()

Returns:

Returns the xuiLocation.

getXUINamespaceMapping

public java.util.Hashtable getXUINamespaceMapping()

Returns the nested fingerprints if any otherwise return an empty Vector.

getXUINamespaceMapping

public java.lang.String getXUINamespaceMapping(java.lang.String namespace)

getXUIURL

public java.net.URL getXUIURL()

hasIncludes

public boolean hasIncludes()

Indicates if this fingerprint includes other xui files.

putProcessingInstructions

public java.lang.Object putProcessingInstructions(java.lang.String key,
                                                  java.lang.String value)

putProcessingInstructions

public java.lang.Object putProcessingInstructions(java.lang.String key,
                                                  java.lang.String value,
                                                  CodeSetEntry codeSetEntry)

putXUINamespaceMapping

public java.lang.String putXUINamespaceMapping(java.lang.String namespace,
                                               java.lang.String prefix)

refresh

public void refresh(FingerPrint xuiFingerprint)

removeProcessingInstruction

public void removeProcessingInstruction(java.lang.String key)

serialize

public java.lang.StringBuffer serialize(Document jaxDom)

Serializes the fingerprint to a StringBuffer.

setAppVersionNo

public void setAppVersionNo(java.lang.String versionNo)

Sets the application version of this fingerprint.

Parameters:

versionNo -

setDBLoadTimeStamp

public void setDBLoadTimeStamp(long loadTimeStamp)

setEntityResolver

public void setEntityResolver(org.apache.xerces.xni.parser.XMLEntityResolver resolver)

setIncludedPDFXUI

public void setIncludedPDFXUI(java.lang.String name)

Sets the included pdf xui name.

Parameters:

name - name of the pdf xui

setLastLoadedLanguage

public void setLastLoadedLanguage(java.lang.String currentLang)

setNLSReadingSequence

public void setNLSReadingSequence(java.lang.String[] langSeq)

Set the nls reading sequence. Lowest priority first!

Parameters:

langSeq -

setPID

public void setPID(java.lang.String pid)

Sets the PID of this document. The pid indicates the persistence id in the persistency layer.

Parameters:

pid - persistence id

setSerializeJAXFrontPI

public void setSerializeJAXFrontPI(boolean serializeJAXFrontPI)

setXmlLocation

public void setXmlLocation(java.lang.String xmlLocation)

Parameters:

xmlLocation - The xmlLocation to set.

setXSDInput

public void setXSDInput(org.w3c.dom.ls.LSInput input)

setXSDJAXContent

public void setXSDJAXContent(java.lang.String content)

setXsdLocation

public void setXsdLocation(java.lang.String xsdLocation)

Parameters:

xsdLocstion - The xsdLocstion to set.

setXUIInput

public void setXUIInput(org.w3c.dom.ls.LSInput input)

setXUIJAXContent

public void setXUIJAXContent(java.lang.String content)

setXuiLocation

public void setXuiLocation(java.lang.String xuiLocation)

Parameters:

xuiLocation - The xuiLocation to set.

setXUINamespaceMapping

public void setXUINamespaceMapping(java.util.Hashtable mapping)

setXuiURL

public void setXuiURL(java.net.URL xuiURL)

update

public void update(java.lang.String jaxfrontPI)