XMLInterface


1   package org.enhydra.shark.xpdl;
2   
3   import java.util.Collection  ;
4   import java.util.List  ;
5   import java.util.Map  ;
6   
7   import org.enhydra.shark.xpdl.elements.Package;
8   
9   /**
10  * Class which purpose is to provide methods which are
11  * used by classes that represents program apstraction of
12  * XML elements. These methods offers support for reading or
13  * writting an XML document.
14   *
15   *  @author Sasa Bojanic
16   */
17  public interface XMLInterface {
18  
19     void setValidation (boolean isActive);
20  
21     public void clearParserErrorMessages ();
22  
23     public boolean isPackageOpened (String   pkgId);
24  
25     public Package   getPackageById (String   pkgId);
26  
27     public Package   getPackageByIdAndVersion (String   pkgId,String   version);
28  
29     public Package   getPackageByFilename (String   filename);
30  
31     public Package   getExternalPackageByRelativeFilePath (
32     String   relativePathToExtPkg,Package   rootPkg);
33  
34     public String   getAbsoluteFilePath (Package   pkg);
35  
36     public Collection   getAllPackages ();
37  
38     public Collection   getAllPackageIds ();
39  
40     public Collection   getAllPackageVersions (String   pkgId);
41  
42     public Collection   getAllPackageFilenames ();
43  
44     public boolean doesPackageFileExists (String   xmlFile);
45  
46     public String   getParentDirectory (Package   pkg);
47  
48     public Package   openPackage (String   pkgReference,boolean handleExternalPackages);
49  
50     public Package   openPackagesFromStreams (List   pkgContents,boolean isFileStream) throws Exception  ;
51  
52     public Package   openPackageFromStream (byte[] pkgContent,boolean isFileStream) throws Exception  ;
53  
54     public Package   parseDocument (String   toParse,boolean isFile);
55  
56     /**
57      * This method should be called immediatelly after opening a document,
58      * otherwise, messages could be invalid.
59      * @return The map which keys are opened packages, and values are the sets
60      * of errors for corresponding package.
61      */
62     public Map   getParsingErrorMessages ();
63  
64     public List   closePackages (String   pkgId);
65  
66     public Package   closePackageVersion (String   pkgId,String   version);
67  
68     public void closeAllPackages ();
69  
70     public String   getIdFromFile (String   xmlFile);
71  
72     public void synchronizePackages (XMLInterface xmlInterface);
73  }
74  
75
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags