A quick intro to TEXTML data structures

A brief survey of TEXTML data structures and related concepts.

Almost all of these data structures and concepts are visible in the user interface to TEXTML Console.

Table 1. TEXTML data structures and related concepts
Data structure or concept Description Class(es) or defined constants
Server An instance of TEXTML Server. A process that manages document bases. A container for multiple document bases.

IxiaServerServices

IxiaServerAdminServices

IxiaPowerServices
Document Data in XML format, or in any other text or binary format. Equivalent to a file in a file system. IxiaDocument (and its nested classes)
Collection An optional container for documents. Equivalent to directories or folders in a file system. Can be organized in a hierarchy (tree).

IxiaCollection (manages one collection)

IxiaCollectionServices (creates and manages collections).
Repository Container for all documents (and collections, if any) in a document base (docbase). Equivalent to the root of a disk drive in a file system. (None)
Indexes Provides a way of searching a docbase without doing a full text search of every document in the repository. Index types include:
  • Words (cannot contains blanks).
  • Strings (can contain blanks).
  • Numbers (integer numerics or decimal numerics).
  • Dates (any date fields)
  • Time (any time fields)
  • Properties such as mime type, user name of creator or last modifier, file size. Includes any custom properties that you create.
 (None)
Document base (docbase) Container for Repository and indexes

IxiaDocBaseServices

IxiaDocBaseAdminServices
Query An XML representation of a search specification for documents in a docbase.  
Documents: user vs system

User documents are added to a docbase by users (normally, users of the application that you are writing).

System documents are DTDs, index definitions, and other configuration files required by TEXTML Server.

  
Document name Unique identifier of a document (within a collection, if any). Equivalent to a file name within a file system.  
Document content

This is easiest to explain for documents that contain only text: what you would see if you saved the document to a text file, and then displayed the file using, for example, Notepad.

IxiaDocument.Content

IxiaDocument.StringContent

IxiaDocument.BinaryContent
Document properties Metadata about the document: its size in bytes, its mime type, the date and time it was created, version numbers, etc. Includes any custom properties that you create.  
Custom properties Additional metadata about the document that you can define, manage, and retrieve to meet the application-specific requirements of your enterprise. These might include workflow status, dates of revision, author name, etc.  
Document list An array of document names (or other document data). Used as a parameter to IxiaDocumentServices.GetDocuments().  
Result An array of results from a call to IxiaDocumentServices.GetDocuments(). For each document in the document list, an array element of result objects is returned. A result is either a document object or an error object. IxiaDocumentServices.Result
Result space Represents the documents you have "hit" in your query. You can create and manipulate subsets of the documents returned in a result space.

IxiaResultSpace

IxiaSubList