TWE 2.3-2 API

org.enhydra.jawe.base.xpdlhandler
Class XPDLHandler

java.lang.Object
  extended byorg.enhydra.shark.xpdl.XMLInterfaceForJDK13
      extended byorg.enhydra.jawe.base.xpdlhandler.XPDLHandler
All Implemented Interfaces:
org.enhydra.shark.xpdl.XMLInterface

public class XPDLHandler
extends org.enhydra.shark.xpdl.XMLInterfaceForJDK13

Class which purpose is to provide methods which are used by classes that represents program apstraction of XML elements. These methods offers support for reading or writting an XML document and for generating the tooltips for for the classes that needs it.


Field Summary
private  java.util.Map fileLocks
           
private  java.util.Map rndAccessFiles
           
protected  XPDLHandlerSettings settings
           
 
Fields inherited from class org.enhydra.shark.xpdl.XMLInterfaceForJDK13
idToPackages, isValidationON, locale, mainPackageReference, packageToParentDirectory, parsingErrorMessages, xmlFileToPackage, xpdlRep
 
Constructor Summary
XPDLHandler()
           
XPDLHandler(XPDLHandlerSettings settings)
           
 
Method Summary
 void changePackageId(org.enhydra.shark.xpdl.elements.Package pkg, java.lang.String oldId, java.lang.String newId)
          This method has to be called from the newly created package after its Id is entered.
 void closeAllPackages()
           
 java.util.List closePackages(java.lang.String pkgId)
           
 org.enhydra.shark.xpdl.elements.Package closePackageVersion(java.lang.String pkgId, java.lang.String pkgVer)
           
 org.enhydra.shark.xpdl.elements.Package getMainPackage()
           
 java.lang.String getMainPackageFilename()
           
 java.lang.String getMainPackageId()
           
 java.io.RandomAccessFile getRaf(org.enhydra.shark.xpdl.elements.Package pkg)
           
 void lockAllFiles()
           
 org.enhydra.shark.xpdl.elements.Package openPackage(java.lang.String pkgReference, boolean handleExternalPackages)
           
protected  org.enhydra.shark.xpdl.elements.Package openPackageRecursively(java.lang.String pkgReference, boolean handleExternalPackages)
           
 void printDebug()
           
 void registerPackage(org.enhydra.shark.xpdl.elements.Package pkg)
          This method has to be called when new package is created.
 void registerPackageFilename(java.lang.String filename, org.enhydra.shark.xpdl.elements.Package pkg)
          This method is called when first saving new package, or when saving it with a different name.
 void synchronizePackages(org.enhydra.shark.xpdl.XMLInterface xmlInterface)
           
 void unlockAllFiles()
           
 
Methods inherited from class org.enhydra.shark.xpdl.XMLInterfaceForJDK13
clearParserErrorMessages, doesPackageFileExists, getAbsoluteFilePath, getAllPackageFilenames, getAllPackageIds, getAllPackages, getAllPackageVersions, getExternalPackageByRelativeFilePath, getPackageByFilename, getPackageById, getPackageByIdAndVersion, getParentDirectory, getParsingErrorMessages, getXPDLRepositoryHandler, isPackageOpened, openPackageFromStream, openPackagesFromStreams, parseDocument, setLocale, setValidation, setXPDLRepositoryHandler
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

settings

protected XPDLHandlerSettings settings

fileLocks

private java.util.Map fileLocks

rndAccessFiles

private java.util.Map rndAccessFiles
Constructor Detail

XPDLHandler

public XPDLHandler()

XPDLHandler

public XPDLHandler(XPDLHandlerSettings settings)
            throws java.lang.Exception
Method Detail

getMainPackage

public org.enhydra.shark.xpdl.elements.Package getMainPackage()

getMainPackageId

public java.lang.String getMainPackageId()

getMainPackageFilename

public java.lang.String getMainPackageFilename()

registerPackage

public void registerPackage(org.enhydra.shark.xpdl.elements.Package pkg)
This method has to be called when new package is created.

Parameters:
pkg -

changePackageId

public void changePackageId(org.enhydra.shark.xpdl.elements.Package pkg,
                            java.lang.String oldId,
                            java.lang.String newId)
This method has to be called from the newly created package after its Id is entered.

Parameters:
pkg -

registerPackageFilename

public void registerPackageFilename(java.lang.String filename,
                                    org.enhydra.shark.xpdl.elements.Package pkg)
This method is called when first saving new package, or when saving it with a different name.

Parameters:
filename -
pkg -

getRaf

public java.io.RandomAccessFile getRaf(org.enhydra.shark.xpdl.elements.Package pkg)

openPackage

public org.enhydra.shark.xpdl.elements.Package openPackage(java.lang.String pkgReference,
                                                           boolean handleExternalPackages)

printDebug

public void printDebug()

openPackageRecursively

protected org.enhydra.shark.xpdl.elements.Package openPackageRecursively(java.lang.String pkgReference,
                                                                         boolean handleExternalPackages)

closePackages

public java.util.List closePackages(java.lang.String pkgId)

closePackageVersion

public org.enhydra.shark.xpdl.elements.Package closePackageVersion(java.lang.String pkgId,
                                                                   java.lang.String pkgVer)

closeAllPackages

public void closeAllPackages()

unlockAllFiles

public void unlockAllFiles()

lockAllFiles

public void lockAllFiles()
                  throws java.lang.Exception
Throws:
java.lang.Exception

synchronizePackages

public void synchronizePackages(org.enhydra.shark.xpdl.XMLInterface xmlInterface)

TWE 2.3-2 API