Changeset 2186

Timestamp:

2001-03-16T09:04:52+13:00 (23 years ago)

Author:

say1

Message:

added comments to corbaiface.idl and an hostname accessor to NzdlCollectionInfo

Location:

trunk/java-client

Files:

• corbaiface.idl (modified) (7 diffs)
• org/nzdl/gsdl/service/NzdlCollectionInfo.java (modified) (2 diffs)

trunk/java-client/corbaiface.idl

@@ -6 +6 @@
 
 typedef sequence<string> stringSeq;
+
+//
+// Used to textual arguments backwards and forwards across
+// the interface. The encoding is 0 for full unicode character
+// data and undefined otherwise.
+//
 
 struct corbatext_t
@@ -18 +24 @@
 typedef corbatext_tarray corbatext_tset;
 
+//
+// A map of names to values. Names may occur twice. Used largely
+// for passing metadata around
+//
+
 struct corbatext_tmap
 {
@@ -27 +38 @@
 
 enum corbaComError
-{ corbaNoError, 
+{ 
+  // There were no errors
+  corbaNoError, 
+  // The server could not authenticate the client or the 
+  // authentication indicated insufficient priviledges
   corbaAuthenticationFailure, 
+  // ??
   corbaProtocolError, 
+  // ??
   corbaConfigurationError, 
+  // The server is unable to provide service due to an
+  // unspecified system problem on the server side.
   corbaSystemProblem
 };
@@ -40 +59 @@
 struct corbaShortColInfo
 {
+  // the textual name of the collection
   corbatext_t name;
+  // the textual name of the server
   corbatext_t host;
+  // ???
   long        response;
 };
@@ -48 +70 @@
 {
   corbaShortColInfo shoftInfo;
+  // the collection is public
   boolean           isPublic;
+  // the collection is reliable
   boolean           isBeta;
+  // the timestamp of the collection building
   unsigned long     buildDate;
+  // ???
   corbatext_tarray  ccsCols;        // Added 05/04/2000
+  // ???
   corbatext_tarray  languages;
+  // the number of documents in the collection
   unsigned long     numDocs;
+  // the number of words in the collection
   unsigned long     numWords;
+  // the number of bytes in the collection
   unsigned long     numBytes;
+  // the collection level metadata
   corbatext_tmap    collectionMeta;
+  // ???
   corbatext_tmap    format;
+  // ???
   corbatext_tmap    building;
+  // the domain for http request for associated files and images
   corbatext_t       httpdomain ;    // Added 27/07/2000
+  // the domain for prefix request for associated files and images
   corbatext_t       httpprefix;     // Added 27/07/2000
+  // the textual name of the receptionist
   corbatext_t       receptionist;
 };
@@ -70 +106 @@
 struct corbaDocRequest
 { 
+  // the document ID
   corbatext_t OID;
+  // the mine type the Doc should be in, or "" for any
   corbatext_t docType;
+  // ??
   corbatext_t docFormat;
 };
@@ -81 +120 @@
 struct corbaDocResponse
 { 
+  // the actual document
   corbatext_t doc;
 };

trunk/java-client/org/nzdl/gsdl/service/NzdlCollectionInfo.java

@@ -50 +50 @@
     if (!getName().equals(""))
       System.out.println("getName working !");
+    if (!getHostName().equals(""))
+      System.out.println("getHostName working !");
   }
 
@@ -68 +70 @@
   public String getName() {
     return NzdlCorbaFactory.toString( m_Info.shoftInfo.name ) ;
+  }
+  /**
+   * Return the Hostname
+   */
+  public String getHostName() {
+    return NzdlCorbaFactory.toString( m_Info.shoftInfo.host ) ;
   }
   /**