Changeset 1838

Timestamp:

04/02/12 21:09:37 (12 years ago)

Author:

gaba

Message:

comments

File:

• MDService2/branches/MDService_simple3/src/eu/clarin/cmdi/mdservice/model/WorkspaceProfile.java (modified) (13 diffs)

MDService2/branches/MDService_simple3/src/eu/clarin/cmdi/mdservice/model/WorkspaceProfile.java

@@ -11 +11 @@
 import java.text.SimpleDateFormat;
 import java.util.Date;
-import java.util.HashMap;
 
 import javax.xml.namespace.QName;
@@ -45 +44 @@
 
 /**
- 
+ * Main WorkspaceProfile functionality, it means loading data from file to DOM Document, 
+ * retrieving data or  data parts  as XMLStream and possibilities of save changed or 
+ * new XML elements. 
+ *  
+ * @author gaba
  */
 
@@ -73 +76 @@
         public static String SERVER = "server";
         
+        // xpaths definitions for lookup in workspaceprofile
         public static String XPATH_EXPR_WORKSPACE = "//Profiles/WorkspaceProfiles/WorkspaceProfile[@user='dummy']";
         public static String XPATH_EXPR_REPOSITORIES = "//Profiles/WorkspaceProfiles/WorkspaceProfile[@user='server']/Repositories";
@@ -116 +120 @@
         }
 
+        /**
+         * Contructor provides initialisation.
+         * 
+         * @return
+         */
         public WorkspaceProfile() {
                 Init();
         }
         
+        /**
+         * Instance of WorkspaceProfile is created.
+         * 
+         * @return
+         */
         public static WorkspaceProfile getWorkspaceProfile() {
                 if (singleton == null) {
@@ -127 +141 @@
         }
         
+        /**
+         * Initialisation constists of 
+         * a) loading configuration
+         * b) setting up the filename of workspaceprofile.xml
+         * c) calling the document initialisation
+         * 
+         */
         public void Init(){
                 //configure
@@ -138 +159 @@
         }
         
+        /**
+         * Initialisation of the DOM Document, representation  of the XML file.
+         * If none workspaceprofile.xml exists, the new  DOM document containig profile data is 
+         * created and saved as WorkspaceProfile.xml
+         * 
+         */
         public void initDocument() {
                 
@@ -201 +228 @@
                 }
 
+        /**
+         * Saving DOM Document representing workspace data into WorkspaceProfile.xml
+         */
         public void saveDocument() {
                 //public void writeQuerycounter (Integer i) {           
@@ -250 +280 @@
         }
         
+        /**
+         * Creates the XPath expression text from constant-defined text by replacing the 'dummy' 
+         * 
+         * @param xpath_expr
+         * @param new_dummy
+         * @return
+         */
         public String getXPathExpressionDummy(String xpath_expr, String new_dummy){
 
@@ -255 +292 @@
         }
 
+        /**
+         * TODO Utils ?
+         * Apply the xpath expression to retrieve the particular data from the workspace.
+         * 
+         * @param xpath_str
+         * @param type
+         * @return
+         * @throws XPathExpressionException
+         */
         public Object getWorkspaceData(String xpath_str, QName type) throws XPathExpressionException{
                 XPathFactory factory = XPathFactory.newInstance(); 
@@ -270 +316 @@
              return result;
         }
-        
+        /*
+         * Creates new workspaceprofile structure.
+         * 
+         */
         public void addWorkspaceToDocument(){
                 //{'WorkspaceProfile':{'CustomTermsets':'null',
@@ -311 +360 @@
         }
         
+        /**
+         * 
+         * Creates the XMLStream from the particular part of the workspaceprofile 
+         * according the xpath expression text.
+         * If document is empty, none data is retrieved the new document is created.
+         */
         public InputStream getXMLStream(String xpath_expr) throws XPathExpressionException, TransformerConfigurationException, TransformerException, TransformerFactoryConfigurationError{
                 InputStream is;
@@ -368 +423 @@
         }
         
+        /**
+         * Save the data of the profile element defined in  json structure into DOM document , which
+         * represents the workspaceprofile.
+         * 
+         * @param jsonData
+         * @return
+         * @throws ParserConfigurationException
+         * @throws SAXException
+         * @throws IOException
+         * @throws DOMException
+         * @throws XPathExpressionException
+         * @throws TransformerException
+         * @throws TransformerFactoryConfigurationError
+         */
         public  String save(String jsonData) throws ParserConfigurationException, SAXException, IOException, DOMException, XPathExpressionException, TransformerException, TransformerFactoryConfigurationError{
                 
@@ -401 +470 @@
         }
         
+        /**
+         * Appends or replace the profile element (new_doc) into workspaceprofile DOM Document.
+         * 
+         * @param new_doc
+         * @return
+         * @throws XPathExpressionException
+         */
         public  String  DocumentReplaceNewElement(Document new_doc) throws XPathExpressionException{
                 String newid = "";