com.jaxfront.core.dom
Class FingerPrint

java.lang.Object
  extended by 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.

Version:
1.60

Field Summary
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_INCLUDE
           
static java.lang.String JAXFRONT_PI_INCLUDE_PDF
           
static java.lang.String JAXFRONT_PI_PID
           
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, java.net.URL xsdURL, org.w3c.dom.ls.LSInput xuiURL)
           
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()
           
 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 getPID()
          Returns the persistent id.
 java.lang.String getProcessingInstruction(java.lang.String key)
           
 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()
           
 java.lang.String getXSDJAXContent()
           
 java.lang.String getXsdLocation()
           
 java.net.URL getXSDURL()
           
 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 setIncludedPDFXUI(java.lang.String name)
          Sets the included pdf xui name.
 void setPID(java.lang.String pid)
          Sets the PID of this document.
 void setXmlLocation(java.lang.String xmlLocation)
           
 void setXSDJAXContent(java.lang.String content)
           
 void setXsdLocation(java.lang.String xsdLocation)
           
 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

JAXFRONT_PI

public static final java.lang.String JAXFRONT_PI
See Also:
Constant Field Values

JAXFRONT_PI_XSD

public static final java.lang.String JAXFRONT_PI_XSD
See Also:
Constant Field Values

JAXFRONT_PI_XML

public static final java.lang.String JAXFRONT_PI_XML
See Also:
Constant Field Values

JAXFRONT_PI_XUI

public static final java.lang.String JAXFRONT_PI_XUI
See Also:
Constant Field Values

JAXFRONT_PI_PID

public static final java.lang.String JAXFRONT_PI_PID
See Also:
Constant Field Values

JAXFRONT_PI_VERSION

public static final java.lang.String JAXFRONT_PI_VERSION
See Also:
Constant Field Values

JAXFRONT_PI_TIME

public static final java.lang.String JAXFRONT_PI_TIME
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_INCLUDE

public static final java.lang.String JAXFRONT_PI_INCLUDE
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

JAXFRONT_PI_INCLUDE_PDF

public static final java.lang.String JAXFRONT_PI_INCLUDE_PDF
See Also:
Constant Field Values

JAXFRONT_PI_CONTROLLER

public static final java.lang.String JAXFRONT_PI_CONTROLLER
See Also:
Constant Field Values
Constructor Detail

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.

FingerPrint

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

getJAXDOM

public Document getJAXDOM()

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

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.


getAppVersionNo

public java.lang.String getAppVersionNo()
Returns the application version no.


getIncludes

public java.util.Vector getIncludes()
Returns a list of included xui file names.


getIncludedPDFXUI

public java.lang.String getIncludedPDFXUI()
Returns the included PDF XUI name.


hasIncludes

public boolean hasIncludes()
Indicates if this fingerprint includes other xui files.


setAppVersionNo

public void setAppVersionNo(java.lang.String versionNo)
Sets the application version of this fingerprint.

Parameters:
versionNo -

serialize

public java.lang.StringBuffer serialize(Document jaxDom)
Serializes the fingerprint to a StringBuffer.


getXSDURL

public java.net.URL getXSDURL()

getXUIURL

public java.net.URL getXUIURL()

getPID

public java.lang.String getPID()
Returns the persistent id. Returns null if the document has not been stored before.


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

getIncludedFingerPrints

public java.util.Vector getIncludedFingerPrints()
Returns the nested fingerprints if any otherwise return an empty Vector.


getXUINamespaceMapping

public java.util.Hashtable getXUINamespaceMapping()
Returns the nested fingerprints if any otherwise return an empty Vector.


putXUINamespaceMapping

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

setXUINamespaceMapping

public void setXUINamespaceMapping(java.util.Hashtable mapping)

getXUINamespaceMapping

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

addIncludedFingerPrint

public void addIncludedFingerPrint(FingerPrint fingerPrint)
Adds an nested fingerprint.

Parameters:
fingerPrint - to add to my list of includes

setIncludedPDFXUI

public void setIncludedPDFXUI(java.lang.String name)
Sets the included pdf xui name.

Parameters:
name - name of the pdf xui

setXuiURL

public void setXuiURL(java.net.URL xuiURL)

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)

getProcessingInstruction

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

removeProcessingInstruction

public void removeProcessingInstruction(java.lang.String key)

setXsdLocation

public void setXsdLocation(java.lang.String xsdLocation)
Parameters:
xsdLocstion - The xsdLocstion to set.

getXsdLocation

public java.lang.String getXsdLocation()
Returns:
Returns the xsdLocstion.

setXmlLocation

public void setXmlLocation(java.lang.String xmlLocation)
Parameters:
xmlLocation - The xmlLocation to set.

getXmlLocation

public java.lang.String getXmlLocation()
Returns:
Returns the xmlLocation.

getController

public java.lang.String getController()

setXuiLocation

public void setXuiLocation(java.lang.String xuiLocation)
Parameters:
xuiLocation - The xuiLocation to set.

getXuiLocation

public java.lang.String getXuiLocation()
Returns:
Returns the xuiLocation.

update

public void update(java.lang.String jaxfrontPI)

refresh

public void refresh(FingerPrint xuiFingerprint)

setXSDJAXContent

public void setXSDJAXContent(java.lang.String content)

setXUIJAXContent

public void setXUIJAXContent(java.lang.String content)

getXSDJAXContent

public java.lang.String getXSDJAXContent()

getXUIJAXContent

public java.lang.String getXUIJAXContent()