org.enhydra.shark.xpdl
Interface XMLInterface

All Known Implementing Classes:
XMLInterfaceForJDK13

public interface XMLInterface

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.

Author:
Sasa Bojanic

Method Summary
 void clearParserErrorMessages()
           
 void closeAllPackages()
           
 java.util.List closePackages(java.lang.String pkgId)
           
 Package closePackageVersion(java.lang.String pkgId, java.lang.String version)
           
 boolean doesPackageFileExists(java.lang.String xmlFile)
           
 java.lang.String getAbsoluteFilePath(Package pkg)
           
 java.util.Collection getAllPackageFilenames()
           
 java.util.Collection getAllPackageIds()
           
 java.util.Collection getAllPackages()
           
 java.util.Collection getAllPackageVersions(java.lang.String pkgId)
           
 Package getExternalPackageByRelativeFilePath(java.lang.String relativePathToExtPkg, Package rootPkg)
           
 Package getPackageByFilename(java.lang.String filename)
           
 Package getPackageById(java.lang.String pkgId)
           
 Package getPackageByIdAndVersion(java.lang.String pkgId, java.lang.String version)
           
 java.lang.String getParentDirectory(Package pkg)
           
 java.util.Map getParsingErrorMessages()
          This method should be called immediatelly after opening a document, otherwise, messages could be invalid.
 boolean isPackageOpened(java.lang.String pkgId)
           
 Package openPackage(java.lang.String pkgReference, boolean handleExternalPackages)
           
 Package openPackageFromStream(byte[] pkgContent, boolean isFileStream)
           
 Package openPackagesFromStreams(java.util.List pkgContents, boolean isFileStream)
           
 Package parseDocument(java.lang.String toParse, boolean isFile)
           
 void setLocale(java.util.Locale locale)
           
 void setValidation(boolean isActive)
           
 void synchronizePackages(XMLInterface xmlInterface)
           
 

Method Detail

setValidation

void setValidation(boolean isActive)

clearParserErrorMessages

void clearParserErrorMessages()

isPackageOpened

boolean isPackageOpened(java.lang.String pkgId)

getPackageById

Package getPackageById(java.lang.String pkgId)

getPackageByIdAndVersion

Package getPackageByIdAndVersion(java.lang.String pkgId,
                                 java.lang.String version)

getPackageByFilename

Package getPackageByFilename(java.lang.String filename)

getExternalPackageByRelativeFilePath

Package getExternalPackageByRelativeFilePath(java.lang.String relativePathToExtPkg,
                                             Package rootPkg)

getAbsoluteFilePath

java.lang.String getAbsoluteFilePath(Package pkg)

getAllPackages

java.util.Collection getAllPackages()

getAllPackageIds

java.util.Collection getAllPackageIds()

getAllPackageVersions

java.util.Collection getAllPackageVersions(java.lang.String pkgId)

getAllPackageFilenames

java.util.Collection getAllPackageFilenames()

doesPackageFileExists

boolean doesPackageFileExists(java.lang.String xmlFile)

getParentDirectory

java.lang.String getParentDirectory(Package pkg)

openPackage

Package openPackage(java.lang.String pkgReference,
                    boolean handleExternalPackages)

openPackagesFromStreams

Package openPackagesFromStreams(java.util.List pkgContents,
                                boolean isFileStream)
                                throws java.lang.Exception
Throws:
java.lang.Exception

openPackageFromStream

Package openPackageFromStream(byte[] pkgContent,
                              boolean isFileStream)
                              throws java.lang.Exception
Throws:
java.lang.Exception

parseDocument

Package parseDocument(java.lang.String toParse,
                      boolean isFile)

getParsingErrorMessages

java.util.Map getParsingErrorMessages()
This method should be called immediatelly after opening a document, otherwise, messages could be invalid.

Returns:
The map which keys are opened packages, and values are the sets of errors for corresponding package.

closePackages

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

closePackageVersion

Package closePackageVersion(java.lang.String pkgId,
                            java.lang.String version)

closeAllPackages

void closeAllPackages()

synchronizePackages

void synchronizePackages(XMLInterface xmlInterface)

setLocale

void setLocale(java.util.Locale locale)