Getting a document by its name

How to: retrieve a document when you know its name; save a document's content as a file encoded in Unicode UTF-16LE; retrieve a document's properties.

The program must be connected to a docbase, and it must have an IxiaDocBaseServices object for that docbase:
IxiaDocBaseServices docbase =    ...

The simplest way to retrieve a document is to know its name. A document name is similar to a file name in Windows or Linux. (If you don't already know the document name, then you must search for the document.)

Usually, you want to retrieve a list of documents; accordingly, you must prepare an array of document names even if you only want to retrieve one document.

Often, you want to save the contents of a document as a file. We will show you how to save it in the Unicode UTF-16LE character encoding, that is, in the 16-bit, little-endian Unicode standard. This encoding is used by recent versions of Microsoft Windows when saving in Unicode.

To retrieve a document by name, and then to save it as a file:

  1. Get the DocumentServices object for the document base that contains the document or documents to be retrieved.
    // Get DocumentServices for <docbase>
    IxiaDocumentServices ds = docbase.DocumentServices();
  2. Prepare an array with one element: a string containing the name of the document to retrieve.
    String [] documents = new String[1];
    documents[0] = documentName;
    To retrieve more than one document: create an array of the appropriate size, then set each element to the name of a document.
  3. Get the document from the docbase.
    IxiaDocumentServices.Result [] result =
            TextmlConstants.TEXTML_DOCUMENT_CONTENT |

    Let's look at the second argument; we are OR-ing two flags:

    • TextmlConstants.TEXTML_DOCUMENT_CONTENT: Retrieve the contents of the document.
    • Constants.TEXTML_DOCUMENT_PROPERTIESTextmlConstants.TEXTML_DOCUMENT_PROPERTIES: Retrieve the properties of the document, i.e., the document's MIME type, date created, date modified, size, and so forth.

    Accordingly, the second argument means "Retrieve the document's contents and properties."

    The third argument, Constants.TEXTML_DOCUMENT, means "Retrieve user document(s)." Note that TEXTML Server stores two kinds of documents:

    • User documents are documents stored by users of the application that you are developing.
    • System documents are DTDs, index definition files, format files, and so forth.

    The call returns a Result object. A Result object is an array of the same size as the array of file names to retrieve. Each element has two fields:

    • A document object (class IxiaDocument).
    • An error object (class TextmlserverError)

    Before we process the document, we must make sure that there was no error returned for that document.

  4. For each document to be retrieved, check whether any error was returned:
    if (result[0].Error != null)
            ("The following error occurred while getting " + documentName);

    If you have more than one document to retrieve, you must index through the result array: for each element in the array, if no error object has been returned, then process the returned document (by, e.g., saving it to disk).

  5. Save the returned document's content (normally text coded in XML) to a disk file:
    // Save the document's content to the <path> specified
    result[0].Document.Content.SaveTo(path + "/" + documentName);
    Console.WriteLine(documentName + " successfully saved.") ;

    Usually, the contents of a TEXTML SDK object is text coded in XML; if so, the MIME type will normally be "text/xml". TEXTML Server can also store binary files with MIME types such as "image/jpeg", "audio/mpeg3", and "application/zip".

    MIME type is an example of a document property. These properties include the size of the document's contents in bytes, the date and time that the document was created, and the date and time that the document was last modified. TEXTML Server stores and manages the properties for each document in a docbase.

  6. Save the returned document's properties to a separate disk file:
    // WriteFile() writes a string to a disk file
    WriteFile (path + "/" + "P_" + documentName + ".xml", 
    Console.WriteLine(documentName + "'s properties successfully saved.") ; 

    The document properties are always returned as an XML string. Here are the properties of a typical document:

    <?xml version='1.0' encoding='UTF-16' ?>
    Note: You can define custom properties for your documents: TEXTML Server will store, manage, and retrieve them along with the standard properties.

You can build and run this sample program: