XML (onecode-esdstudio 1.0.8 API)

java.lang.Object
- com.ds.bpm.bpd.xml.XML

所有已实现的接口:

XMLInterface
```
public class XML
extends Object
implements 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 and for generating the tooltips for for the classes that needs it.

构造器概要

构造器
构造器和说明

XML()

构造器
构造器和说明
`XML()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`clearParserErrorMessages()`
`void`	`closeAllPackages()`
`void`	`closePackage(String pkgId)`
`boolean`	`doesPackageFileExists(String xmlFile)`
`String`	`getAbsoluteFilePath(Package pkg)`
`Collection`	`getAllPackageFilenames()`
`Collection`	`getAllPackageIds()`
`Collection`	`getAllPackages()`
`Package`	`getExternalPackageByRelativeFilePath(String relativePathToExtPkg, Package rootPkg)`
`String`	`getIDFromFile(String xmlFile)`
`Package`	`getPackageByFilename(String filename)`
`Package`	`getPackageById(String pkgId)`
`String`	`getPackageFileContent(String pkgId)`
`String`	`getParentDirectory(Package pkg)`
`Map`	`getParsingErrorMessages()` This method should be called immediatelly after opening a document, otherwise, messages could be invalid.
`RandomAccessFile`	`getRaf(Package pkg)`
`boolean`	`isPackageOpened(String pkgId)`
`void`	`lockAllFiles()`
`Package`	`openPackage(String pkgReference, boolean openFromStream)`
`Package`	`parseDocument(String toParse, boolean isFile)`
`void`	`printDebug()`
`void`	`putPkgIdToFileContentMapping(String pkgId, String fileContent)`
`void`	`register(Package pkg)` This method has to be called from the newly created package after its Id is entered.
`void`	`registerPackageFilename(String filename, Package pkg)` This method is called when first saving new package, or when saving it with a different name.
`static int`	`registerWorkflowVersion(String workflowId)`
`void`	`setFileLockingStatus(boolean status)`
`void`	`setValidation(boolean isActive)`
`void`	`unlockAllFiles()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - XML
```
public XML()
```
- 方法详细资料
  - setValidation
```
public void setValidation(boolean isActive)
```
    指定者:
    
    setValidation 在接口中 XMLInterface
  - setFileLockingStatus
```
public void setFileLockingStatus(boolean status)
```
  - clearParserErrorMessages
```
public void clearParserErrorMessages()
```
    指定者:
    
    clearParserErrorMessages 在接口中 XMLInterface
  - register
```
public void register(Package pkg)
```
    This method has to be called from the newly created package after its Id is entered.
    
    指定者:
    
    register 在接口中 XMLInterface
    
    参数:
    
    pkg -
  - registerPackageFilename
```
public void registerPackageFilename(String filename,
                                    Package pkg)
```
    This method is called when first saving new package, or when saving it with a different name.
    
    指定者:
    
    registerPackageFilename 在接口中 XMLInterface
    
    参数:
    
    filename -
    
    pkg -
  - isPackageOpened
```
public boolean isPackageOpened(String pkgId)
```
    指定者:
    
    isPackageOpened 在接口中 XMLInterface
  - putPkgIdToFileContentMapping
```
public void putPkgIdToFileContentMapping(String pkgId,
                                         String fileContent)
```
    指定者:
    
    putPkgIdToFileContentMapping 在接口中 XMLInterface
  - getPackageFileContent
```
public String getPackageFileContent(String pkgId)
```
    指定者:
    
    getPackageFileContent 在接口中 XMLInterface
  - getPackageById
```
public Package getPackageById(String pkgId)
```
    指定者:
    
    getPackageById 在接口中 XMLInterface
  - getPackageByFilename
```
public Package getPackageByFilename(String filename)
```
    指定者:
    
    getPackageByFilename 在接口中 XMLInterface
  - getRaf
```
public RandomAccessFile getRaf(Package pkg)
```
  - getExternalPackageByRelativeFilePath
```
public Package getExternalPackageByRelativeFilePath(String relativePathToExtPkg,
                                                    Package rootPkg)
```
    指定者:
    
    getExternalPackageByRelativeFilePath 在接口中 XMLInterface
  - getAbsoluteFilePath
```
public String getAbsoluteFilePath(Package pkg)
```
    指定者:
    
    getAbsoluteFilePath 在接口中 XMLInterface
  - getAllPackages
```
public Collection getAllPackages()
```
    指定者:
    
    getAllPackages 在接口中 XMLInterface
  - getAllPackageIds
```
public Collection getAllPackageIds()
```
    指定者:
    
    getAllPackageIds 在接口中 XMLInterface
  - getAllPackageFilenames
```
public Collection getAllPackageFilenames()
```
    指定者:
    
    getAllPackageFilenames 在接口中 XMLInterface
  - doesPackageFileExists
```
public boolean doesPackageFileExists(String xmlFile)
```
    指定者:
    
    doesPackageFileExists 在接口中 XMLInterface
  - getParentDirectory
```
public String getParentDirectory(Package pkg)
```
    指定者:
    
    getParentDirectory 在接口中 XMLInterface
  - openPackage
```
public Package openPackage(String pkgReference,
                           boolean openFromStream)
```
    指定者:
    
    openPackage 在接口中 XMLInterface
  - printDebug
```
public void printDebug()
```
  - parseDocument
```
public Package parseDocument(String toParse,
                             boolean isFile)
```
    指定者:
    
    parseDocument 在接口中 XMLInterface
  - getParsingErrorMessages
```
public Map getParsingErrorMessages()
```
    This method should be called immediatelly after opening a document, otherwise, messages could be invalid.
    
    指定者:
    
    getParsingErrorMessages 在接口中 XMLInterface
    
    返回:
    
    The map which keys are opened packages, and values are the sets of errors for corresponding package.
  - closePackage
```
public void closePackage(String pkgId)
```
    指定者:
    
    closePackage 在接口中 XMLInterface
  - closeAllPackages
```
public void closeAllPackages()
```
    指定者:
    
    closeAllPackages 在接口中 XMLInterface
  - unlockAllFiles
```
public void unlockAllFiles()
```
  - lockAllFiles
```
public void lockAllFiles()
```
  - getIDFromFile
```
public String getIDFromFile(String xmlFile)
```
    指定者:
    
    getIDFromFile 在接口中 XMLInterface
  - registerWorkflowVersion
```
public static int registerWorkflowVersion(String workflowId)
```

类 XML

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

XML

方法详细资料

setValidation

setFileLockingStatus

clearParserErrorMessages

register

registerPackageFilename

isPackageOpened

putPkgIdToFileContentMapping

getPackageFileContent

getPackageById

getPackageByFilename

getRaf

getExternalPackageByRelativeFilePath

getAbsoluteFilePath

getAllPackages

getAllPackageIds

getAllPackageFilenames

doesPackageFileExists

getParentDirectory

openPackage

printDebug

parseDocument

getParsingErrorMessages

closePackage

closeAllPackages

unlockAllFiles

lockAllFiles

getIDFromFile

registerWorkflowVersion