Package | Description |
---|---|
com.tietoenator.trip.jxp |
Main TRIPjxp package that contains generic classes and enumerations.
|
com.tietoenator.trip.jxp.ccl |
CCL command processing support.
|
com.tietoenator.trip.jxp.classification |
TRIP text classification support.
|
com.tietoenator.trip.jxp.control |
CONTROL database inspection and manipulation.
|
com.tietoenator.trip.jxp.data |
Database content manipulation.
|
com.tietoenator.trip.jxp.database |
Classes to inspect and modify database design.
|
com.tietoenator.trip.jxp.facet |
Classes for generation of facets.
|
com.tietoenator.trip.jxp.forms |
TRIP kernel formats for entry, output and search.
|
com.tietoenator.trip.jxp.graph |
[EXPERIMENTAL] Graph database querying and manipulation.
|
com.tietoenator.trip.jxp.grid |
Manipulation of TRIP grid configurations.
|
com.tietoenator.trip.jxp.logging |
Session logger classes.
|
com.tietoenator.trip.jxp.pool |
Classes for session pooling support.
|
com.tietoenator.trip.jxp.session |
Classes for estalishing and maintaining a session.
|
com.tietoenator.trip.jxp.users |
Classes for inspection and manipulation of users and groups.
|
Constructor and Description |
---|
TdbMessageProvidingList(TdbMessageProvidingList<E> r)
Copy constructor, used to derive a list from an existing list
|
TdbMessageProvidingList(TdbSession session,
TdbInterfaceType type)
Constructor, should only be used by a derived class
|
Modifier and Type | Method and Description |
---|---|
void |
TdbCclCommand.checkPoint()
Set a checkpoint in the execution sequence to which the session can later
be rolled-back.
|
void |
TdbKernelWindow.close()
Close the kernel window, release any associated resources on both client and server.
|
void |
TdbCclCommand.execDirect(java.lang.String command)
Execute a CCL command.
|
void |
TdbCclCommand.execXPath(java.lang.String xpathStatement)
Execute a query in XPath syntax.
|
TdbTerm |
TdbTermList.get(int index)
Returns a TdbTerm instance for the term at the specified index.
|
void |
TdbCclCommand.mapKernelWindow(TdbKernelWindow window)
Maps a kernel window buffer to a local window structure, so that results generated
by a CCL command are intercepted by the appropriate class instance.
|
void |
TdbCclCommand.rollbackToCheckPoint()
Rollback the query session to a previously established check point
Invoking this method causes network I/O.
|
void |
TdbKernelWindow.scrollDown()
Scroll the buffer "down" a "page" at a time.
|
void |
TdbKernelWindow.scrollNext()
Scroll the buffer "down" so that the next record after the last currently being
displayed in the buffer is at the top of the buffer.
|
void |
TdbKernelWindow.scrollPrevious()
Scroll the buffer "up" so that the previous record before the topmost
currently being displayed in the buffer is at the top of the buffer.
|
void |
TdbKernelWindow.scrollUp()
Scroll the buffer "up" a "page" at a time.
|
void |
TdbCclCommand.setUseOnDemandTermLists(boolean enable)
Enable or disable the use of the on-demand term list feature.
|
TdbTerm[] |
TdbTermList.toArray()
Returns the entire term list as an array.
|
java.lang.String |
TdbKernelWindow.toFormattedString(java.lang.String before,
java.lang.String after,
java.lang.String linebreak)
Create a formatted string from the buffer's current contents.
|
Constructor and Description |
---|
TdbCclCommand(TdbSession session)
Constructor, creates a blank instance ready for command execution
|
TdbKernelWindow(TdbSession session)
Constructor, doesn't create a server buffer
|
TdbKernelWindow(TdbSession session,
TdbKernelWindowType type)
Constructor, creates a new kernel window buffer on the server with dimensions 20x80
|
TdbKernelWindow(TdbSession session,
TdbKernelWindowType type,
int rows,
int cols)
Constructor, creates a new kernel window buffer on the server.
|
Modifier and Type | Method and Description |
---|---|
TdbCategory |
TdbClassificationScheme.add(java.lang.String name,
java.lang.String comment)
Add a new category to the scheme.
|
void |
TdbClassificationScheme.classify(java.lang.String data,
java.util.List<TdbCategory> categories)
Test classification with the container.
|
void |
TdbClassificationScheme.create()
Create a new container
|
void |
TdbClassificationScheme.create(java.lang.String name)
Create a new container.
|
void |
TdbClassificationScheme.create(java.lang.String name,
int subsystem)
Create a new container, using the specified subsystem.
|
void |
TdbClassificationScheme.create(java.lang.String name,
int subsystem,
int max_items)
Create a new container, using the specified subsystem.
|
void |
TdbClassificationScheme.delete()
Remove the current container from the server in its entirety.
|
void |
TdbClassificationScheme.delete(java.lang.String name)
Remove a container from the server in its entirety.
|
void |
TdbClassificationScheme.finalizeContainer()
Finalize container training, whatever that means for the underlying subsystem.
|
void |
TdbCategory.get()
Retrieve information about the category.
|
void |
TdbClassificationScheme.get()
Retrieve the properties of the current container, including the list of all categories
defined within it.
|
void |
TdbClassificationScheme.get(java.lang.String name)
Retrieve the properties of a container, including the list of all categories
defined within it.
|
TdbCategory |
TdbClassificationScheme.getCategory(int id)
Retrieve the category with the provided unique ID, if found.
|
int |
TdbCategory.getId()
Retrieve the unique ID assigned by the server to this category
|
void |
TdbClassificationScheme.infer(java.lang.String database,
java.lang.String fieldname)
Infer classes and training data from a previous classified database.
|
void |
TdbClassificationScheme.infer(java.lang.String database,
java.lang.String fieldname,
int threshold)
Infer classes and training data from a previous classified database.
|
void |
TdbClassificationScheme.put()
Store any saved attributes of the container, e.g.
|
TdbCategory |
TdbClassificationScheme.remove(java.lang.String name)
Remove an existing category from the scheme
|
void |
TdbClassificationScheme.remove(TdbCategory cat)
Remove an existing category from the scheme
|
void |
TdbCategory.rename()
Rename the category and/or provide it with a new comment.
|
void |
TdbClassificationScheme.rename(java.lang.String newname)
Rename the current container.
|
void |
TdbCategory.train(java.lang.String data,
java.lang.String filename,
TdbTrainingInfo info)
Add training data to the category.
|
void |
TdbCategory.untrain()
Remove all training data for this category.
|
Constructor and Description |
---|
TdbCategory(TdbSession session)
Constructor, creates a blank instance
|
TdbCategory(TdbSession session,
TdbControlObject ob)
Constructor, creates an instance for the category referenced by the provided Control object
|
TdbClassificationScheme(TdbSession session)
Constructor, creates a blank container
|
TdbClassificationScheme(TdbSession session,
TdbControlObject ob)
Constructor, creates an object for the container referenced by the
provided TdbControlObject
|
Modifier and Type | Method and Description |
---|---|
void |
TdbEntryFormList.get(java.lang.String name)
Retrieve entry forms from a named database, regardless of how the
object was constructed.
|
void |
TdbOutputFormatList.get(java.lang.String name)
Retrieve report forms from a named database, regardless of how the
object was constructed.
|
void |
TdbControlObjectList.refresh()
Refresh the list with the latest view from the server; note that if this
list was constructed using the copy constructor from an existing list, this
call will fail with an exception (UNEXPECTED_STATE) thrown.
|
Constructor and Description |
---|
TdbClassificationSchemesList(TdbSession session)
Constructor, retrieve the list of available classification schemes
|
TdbControlObjectList(TdbControlObjectList r)
Copy constructor, used to derive a list from an existing list; doesn't copy
the last document reference
|
TdbControlObjectList(TdbSession session,
TdbInterfaceType type)
Constructor, should only be used by a derived class
|
TdbDatabaseAccessList(TdbSession session,
java.lang.String dbname)
Constructor, retrieves the access rights for the named database
|
TdbDatabaseFieldList(TdbSession session,
java.lang.String db)
Shortcut constructor that retrieves all fields from both head and part record structures
|
TdbDatabaseFieldList(TdbSession session,
java.lang.String db,
int type,
boolean headonly)
Constructor, retrieves a list of fields from the named database of the specified type (if any)
|
TdbDatabaseFieldList(TdbSession session,
java.lang.String db,
java.util.Vector types,
boolean headonly)
Constructor, retrieves a list of fields from the named database of the specified types (if any)
|
TdbDatabaseList(TdbSession session)
Request a list of all databases to which the calling process has at least
read access.
|
TdbDatabaseList(TdbSession session,
java.lang.String name)
Request a control object for a single, specific database, thesauri
or cluster to which the calling process has at least read access.
|
TdbDatabaseList(TdbSession session,
java.lang.String name,
boolean noBaf)
Request a control object for a single, specific database, thesauri
or cluster to which the calling process has at least read access.
|
TdbDatabaseList(TdbSession session,
TdbExtendedDatabaseType type)
Request a list of all databases of the stated type to which the calling process
has at least read access.
|
TdbDatabaseList(TdbSession session,
TdbExtendedDatabaseType type,
boolean noBaf)
Request a list of all databases of the stated type to which the calling process
has at least read access.
|
TdbEntryFormList(TdbSession session)
Constructor -- the resulting object contains no forms and must
be initialized using the get(String) method
|
TdbEntryFormList(TdbSession session,
java.lang.String db)
Constructor, retrieves entry forms from a named database
|
TdbEntryFormList(TdbSession session,
TdbControlObject ob)
Constructor, retrieves entry forms from the database identified by
a Control object
|
TdbEntryFormList(TdbSession session,
TdbDatabaseDesign db)
Constructor, retrieves entry forms from the database identified by
the database's design object
|
TdbFileManagerList(TdbSession session)
Constructor, retrieve a list of file managers
|
TdbFileManagerList(TdbSession session,
boolean self)
Constructor, retrieve a list of file managers
|
TdbGroupAccessList(TdbSession session,
java.lang.String groupname)
Constructor -- retrieve the access rights for the named user group
|
TdbGroupList(TdbSession session)
Constructor -- shortcut that retrieves all known group
|
TdbGroupList(TdbSession session,
java.lang.String user)
Constructor -- shortcut that retrieves groups to which the named user belongs
|
TdbGroupList(TdbSession session,
java.lang.String user,
boolean incPublic)
Constructor -- shortcut
|
TdbGroupList(TdbSession session,
java.lang.String user,
boolean incPublic,
boolean all)
Constructor -- retrieve the list of groups from the server
|
TdbGroupMemberList(TdbSession session,
java.lang.String groupname)
Constructor, retrieves the list of members of the named user group
|
TdbManagerList(TdbSession session)
Constructor, retrieve a list of managers of any type
|
TdbManagerList(TdbSession session,
boolean self)
Constructor, retrieve a list of managers of any type
|
TdbOutputFormatList(TdbSession session)
Constructor -- the resulting object contains no forms and must
be initialized using the get(String) method
|
TdbOutputFormatList(TdbSession session,
java.lang.String db)
Constructor, retrieves report forms from a named database
|
TdbOutputFormatList(TdbSession session,
TdbControlObject ob)
Constructor, retrieves report forms from the database identified by
a Control object
|
TdbOutputFormatList(TdbSession session,
TdbDatabaseDesign db)
Constructor, retrieves report forms from the database identified by
the database's design object
|
TdbOwnedDatabaseList(TdbSession session)
Requests a list of databases owned by the calling process
|
TdbOwnedDatabaseList(TdbSession session,
java.lang.String type)
Requests a list of databases of a certain type owned by the calling process
|
TdbProcedureList(TdbSession session,
java.lang.String userOrGroup)
Constructor, retrieves the list of procedures owned by a particular user or group
|
TdbPublicAccessList(TdbSession session)
Constructor -- retrieve the access rights for the PUBLIC group
|
TdbPublicMemberList(TdbSession session)
Constructor, retrieves the list of members of the special group
PUBLIC.
|
TdbSearchFormList(TdbSession session)
Constructor, retrieves a list of available search forms
|
TdbUserAccessList(TdbSession session,
java.lang.String username)
Constructor, retrieve the database access rights explicitly granted to a particular user.
|
TdbUserAccessList(TdbSession session,
java.lang.String username,
boolean includeGroups)
Constructor, retrieve the database access rights for a particular user.
|
TdbUserList(TdbSession session)
Shortcut constructor, retrieves a simple list of users
|
TdbUserList(TdbSession session,
boolean self,
boolean all)
Constructor, retrieves a list of users
|
TdbUserList(TdbSession session,
int filter,
boolean self,
boolean all)
Constructor, retrieve a list of users and/or managers of a specific type
|
TdbUserManagerList(TdbSession session)
Constructor, retrieve a list of user managers
|
TdbUserManagerList(TdbSession session,
boolean self)
Constructor, retrieve a list of user managers
|
Modifier and Type | Method and Description |
---|---|
void |
TdbNlpInfo.addInputField(java.lang.String name)
Add the name of a field on which to base meta-data processing.
|
void |
TdbGraphRecord.addKeyword(java.lang.String keyword)
Add a keyword to this graph record.
|
TdbSearchSet |
TdbSearch.addSearchSet(int searchId)
Associates a pre-existing search set with this TdbSearch instance.
|
void |
TdbRecord.addToTemplate(java.lang.String name)
Add a particular field by name to the overall retrieval template.
|
void |
TdbRecord.addToTemplate(java.lang.String fieldName,
java.lang.String baseName)
Add a particular field by name to the overall retrieval template.
|
void |
TdbRecord.addToTemplate(TdbFieldTemplate tmpl)
Add a particular field template to the overall retrieval template.
|
TdbTuple |
TdbTupleList.append()
Creates and appends a new tuple.
|
abstract void |
TdbField.appendValue(java.lang.String val)
Append a new subfield or paragraph to the field
|
void |
TdbStringField.appendValue(java.lang.String value)
Not supported for STring fields
|
void |
TdbStructuredField.appendValue(java.lang.String val)
Append a new subfield to the field.
|
void |
TdbTextField.appendValue(java.lang.String val)
Append the provided paragraph text to the field's value
This method cannot be used after any calls have been made to setText() or appendText() as the field is no longer defined in terms of paragraphs at that point. |
org.w3c.dom.Document |
TdbSearchSet.asFragmentSet(java.lang.String xpathExpression,
int from,
int to,
boolean hitMarkup)
Get this search set as an XML fragment set.
|
void |
TdbSearchSet.cancel() |
void |
TdbSearch.cancel() |
void |
TdbTuple.clear()
Blanks out all the TRIP subfield values represented by this tuple.
|
void |
TdbSearch.close()
Release server resources associated with this TdbSearch instance.
|
void |
TdbRecord.commit()
Commit the current record to the current database.
|
void |
TdbStringField.convert(TdbRenditionType rendition,
java.lang.String originalFilename,
java.lang.String outputDirectory,
java.lang.String outputFilename,
java.lang.String preferredAdapter,
TdbTextField highlightSourceField,
boolean refreshHitLocations)
Render the contents of the field to HTML and write it to a file.
|
TdbRecord |
TdbRecord.copy(java.lang.String targetDatabase)
Copies the current record to the specified database.
|
TdbRecord |
TdbRecord.copy(TdbDatabaseDesign targetDatabase)
Copies the current record to the specified database.
|
void |
TdbStringField.copyFromFile(java.lang.String name)
Copy the content of the specified file into this field
|
TdbField |
TdbComponent.createField(java.lang.String name,
TdbFieldType type)
Create a new field instance
This factory method creates a TdbField-derived object of the appropriate class and associates the new instance with this component. |
TdbField |
TdbComponent.createField(TdbFieldDesign design)
Create a new field instance
This factory method creates a TdbField-derived object of the appropriate class and associates the new instance with this component. |
void |
TdbRecordSet.delete()
Delete the records covered by the record set from their database(s)
This method causes network I/O. |
void |
TdbRecord.delete()
Delete the current record from the current database
In order to call this method successfully, the calling application must first establish the database name and record id to be deleted, using the methods setDatabaseName() and setRecordId(). |
void |
TdbSearchSet.delete()
Delete the current search set.
|
void |
TdbRecord.deleteComponent(int index)
Delete the identified component from the current record.
|
void |
TdbRecord.deleteComponent(java.lang.String name)
Delete the named component from the current record.
|
void |
TdbSearch.execute(java.lang.String cclStatement)
Execute a CCL statement.
|
void |
TdbSearch.executeXPath(java.lang.String xpathStatement)
Execute an XPath statement as a query.
|
void |
TdbRecordSet.get()
Retrieve the record set defined by the various properties of the instance.
|
void |
TdbRecord.get()
Retrieve the current record from the current database
Prior to calling this method, the calling application must have established context using the setDatabaseName() method along with one of the setRecordName() or setRecordId() methods. |
TdbTuple |
TdbTupleList.get(int tupleIndex)
Get the row (tuple) at the specified index.
|
org.w3c.dom.Document |
TdbRecordSet.get(TdbDataFormat fmt)
Retrieve the record set defined by the various properties of the instance.
|
org.w3c.dom.Document |
TdbRecord.get(TdbDataFormat format)
Retrieve the current record from the current database.
|
byte[] |
TdbStringField.getBlob()
Retrieve the current value (in total) of the field.
|
java.lang.String |
TdbTupleList.getColumnName(int index)
Returns the (field) name of the specified column.
|
TdbFieldType |
TdbTupleList.getColumnType(int index)
Returns the (field) type of the specified column.
|
TdbComponent |
TdbRecord.getComponent(java.lang.String name)
Retrieve the named component
Note that by design, the components retrieved by this method are "live" and any updates on them are performed directly on the component representation maintained within the TdbRecord instance. |
java.util.List<java.lang.String> |
TdbGraphRecord.getKeywords()
Return a list of all keywords assigned to this graph record.
|
java.lang.String |
TdbGraphRecord.getName()
Returns the name of the graph record.
|
java.lang.String |
TdbComponent.getName()
Retrieve the current value of the part name field (only valid for
part components, obviously).
|
java.lang.String |
TdbGraphRecord.getProperty(java.lang.String name)
Retrieve the value for a property.
|
int |
TdbGraphRecord.getPropertyCount()
Returns a count of the number of properties assigned to this graph database record.
|
java.lang.String |
TdbGraphRecord.getPropertyName(int index)
Returns the name of the property at the specified index.
|
java.lang.String |
TdbGraphRecord.getPropertyValue(int index)
Returns the value of the property at the specified index.
|
TdbRecord |
TdbSearchSet.getRecord(int index)
Returns a TdbRecord instance for a record in the current search set.
|
int |
TdbRecord.getRecordId()
Retrieve the current value of the record number field, if any.
|
java.lang.String |
TdbRecord.getRecordName()
Retrieve the current value, if any, of the record name field
|
java.lang.String |
TdbGraphRecord.getReferenceDatabase()
Returns the database name for the record referenced from this graph record.
|
int |
TdbGraphRecord.getReferenceRecordId()
Returns the record ID of the record referenced from this graph record.
|
java.lang.String |
TdbStringField.getRendition()
Retrieve the rendition of the field that was requested during the most
recent retrieval.
|
TdbSearchSet |
TdbSearch.getSearchSet(int index)
Returns a TdbSearchSet object for a search associated with this TdbSearch instance.
|
java.lang.String |
TdbGraphRecord.getSourceDatabase()
Returns the database name for record used as source vertex for this graph record.
|
int |
TdbGraphRecord.getSourceRecordId()
Returns the record ID of the record used as source vertex for this graph record.
|
java.lang.String |
TdbGraphRecord.getTargetDatabase()
Returns the database name for record used as target vertex for this graph record.
|
int |
TdbGraphRecord.getTargetRecordId()
Returns the record ID of the record used as target vertex for this graph record.
|
java.util.Date |
TdbRecord.getTimeStamp()
Returns the time stamp for when the current record was stored.
|
java.lang.String |
TdbXmlRecord.getUrlBase()
Returns the URL base of the document, i.e.
|
abstract java.lang.String |
TdbField.getValue(int index)
Get the subfield or paragraph value at the defined index
|
java.lang.String |
TdbStringField.getValue(int index)
Not supported for STring fields
|
java.lang.String |
TdbStructuredField.getValue(int index)
Get the subfield value at the defined index.
|
java.lang.String |
TdbTuple.getValue(int fieldIndex)
Get the value of a field within the tuple.
|
java.lang.String |
TdbTextField.getValue(int index)
Retrieve the value of the n'th paragraph.
|
java.lang.String |
TdbTuple.getValue(java.lang.String fieldName)
Get the value of a field within the tuple.
|
abstract int |
TdbField.getValueCount()
Retrieve the count of the values in the field.
|
int |
TdbStringField.getValueCount()
Not supported for STring fields
|
int |
TdbStructuredField.getValueCount()
Retrieve the count of the values in the field.
|
int |
TdbTextField.getValueCount()
Retrieve the number of paragraphs in the field.
|
double |
TdbGraphRecord.getWeight()
Returns the weight value for an edge record.
|
void |
TdbRecordSet.insert(java.util.Collection<TdbRecord> records)
Insert new records to the database associated with this record set
Only the database (see setDatabase()) property is valid for this method. |
TdbTuple |
TdbTupleList.insert(int tupleIndex)
Creates and inserts a new tuple.
|
abstract void |
TdbField.insertValue(int index,
java.lang.String value)
Inserts a new subfield or paragraph into the field.
|
void |
TdbStringField.insertValue(int index,
java.lang.String value)
Not supported for STring fields
|
void |
TdbStructuredField.insertValue(int index,
java.lang.String value)
Inserts a new subfield into the field.
|
void |
TdbTextField.insertValue(int index,
java.lang.String value)
Inserts a new paragraph into the field.
|
void |
TdbRecord.lock()
Request an exclusive lock on this record.
|
void |
TdbNlpInfo.mapMetadataField(java.lang.String categoryName,
java.lang.String fieldName)
Define a field to hold the values for a particular meta-data category.
|
abstract java.util.List<java.lang.String> |
TdbField.originalValues()
Retrieve the display content of the field.
|
java.util.List<java.lang.String> |
TdbStringField.originalValues()
Not supported for STring fields
|
void |
TdbXmlRecord.prepareExport(java.lang.String fileOrDir)
Prepares to export the contents of the record to a file.
|
void |
TdbXmlRecord.prepareImport(java.io.InputStream stream,
TdbXmlRecord.XmlRecordType type,
java.lang.String fileName)
Prepare to import a document into a TRIPxml database.
|
TdbRecord |
TdbRecordSet.recordAt(int offset)
Retrieve the TdbRecord at the defined offset within the set
If the provided offset is outside of the bounds of the record set, an INVALID_ARGS exception is thrown. |
void |
TdbTuple.remove()
Removes the tuple associated with this TdbTuple instance.
|
void |
TdbTupleList.remove(int tupleIndex)
Removes a tuple.
|
void |
TdbGraphRecord.removeKeyword(int index)
Remove a keyword from this graph record.
|
void |
TdbGraphRecord.removeKeyword(java.lang.String keyword)
Remove a keyword from this graph record.
|
void |
TdbGraphRecord.removeProperty(java.lang.String name)
Removes a named property from this graph record.
|
abstract void |
TdbField.removeValue(int index)
Removes a subfield or paragraph from the field.
|
void |
TdbStringField.removeValue(int index)
Not supported for STring fields
|
void |
TdbStructuredField.removeValue(int index)
Removes a subfield from the field.
|
void |
TdbTextField.removeValue(int index)
Removes a paragraph from the field.
|
void |
TdbSearchSet.setCacheSize(int maxBlocks)
Set the size of the record cache.
|
void |
TdbSearchSet.setCancelable(boolean cancelable) |
void |
TdbSearch.setCancelable(boolean cancelable) |
void |
TdbTupleList.setComponent(TdbComponent cmp)
Set the component that holds the fields in the tuple list.
|
void |
TdbTupleList.setDefinition(java.lang.String strFieldList)
Modify the tuple list to use a new set of fields in the same component.
|
void |
TdbTextExtractionInfo.setExtractFromStored(boolean extractFromStored)
Determines if the text extraction should be performed from the
value already stored in the STRING field defined by the property
BinaryCopyField.
|
void |
TdbStringField.setExtractionTarget(java.lang.String name)
Deprecated.
Use the TextExtractionInfo class via the TdbTextField method
getTextExtractionInfo() instead.
|
void |
TdbGraphRecord.setGraphRecordType(TdbGraphRecordType type)
Set the type of the graph record.
|
void |
TdbNlpInfo.setKeywordField(java.lang.String fieldname)
Set the name of the field to receive extracted keywords.
|
void |
TdbNlpInfo.setMetadataTupleFields(java.lang.String namefield,
java.lang.String valuefield)
Set the names of the field to receive extracted meta-data.
|
void |
TdbGraphRecord.setName(java.lang.String name)
Assigns the name of the record.
|
void |
TdbRecordSet.setName(java.lang.String name)
Establish the name of the record covered by this record set.
|
void |
TdbComponent.setName(java.lang.String name)
Establish, or modify, the value of the part name field (only valid for
part components, obviously).
|
void |
TdbGraphRecord.setProperty(java.lang.String name,
java.lang.String value)
Assign a property to this graph record.
|
void |
TdbRecordSet.setQuery(java.lang.String query)
Set a query statement that will be used to retrieve records
Setting a query as the domain of the record set works in conjunction with the setDatabase() setting, i.e. |
void |
TdbRecord.setRecordId(int id)
Establish the value of the record number field
|
void |
TdbRecord.setRecordName(java.lang.String name)
Set the value of the record name field
|
void |
TdbGraphRecord.setReference(java.lang.String databaseName,
int recordId,
java.lang.String recordName)
Set a reference to a pre-existing record.
|
void |
TdbGraphRecord.setReference(TdbRecord rec)
Set a reference to a pre-existing record.
|
void |
TdbGraphRecord.setSourceRecord(int recordId,
java.lang.String recordName)
Set the source record for a graph edge.
|
void |
TdbGraphRecord.setSourceRecord(java.lang.String databaseName,
int recordId)
Set the source record for a graph edge.
|
void |
TdbGraphRecord.setSourceRecord(TdbRecord rec)
Set the source record for a graph edge.
|
void |
TdbGraphRecord.setTargetRecord(int recordId,
java.lang.String recordName)
Set the target record for a graph edge.
|
void |
TdbGraphRecord.setTargetRecord(java.lang.String databaseName,
int recordId)
Set the target record for a graph edge.
|
void |
TdbGraphRecord.setTargetRecord(TdbRecord rec)
Set the target record for a graph edge.
|
void |
TdbSearch.setUseOnDemandTermLists(boolean enable)
Enable or disable the use of the on-demand term list feature.
|
abstract void |
TdbField.setValue(int index,
java.lang.String val)
Set the defined subfield or paragraph to the provided value
Note that the index provided must lie within the current bounds of the field. |
void |
TdbStringField.setValue(int index,
java.lang.String value)
Not supported for STring fields
|
void |
TdbStructuredField.setValue(int index,
java.lang.String val)
Set the defined subfield to the provided value.
|
void |
TdbTuple.setValue(int fieldIndex,
java.lang.String val)
Set the value of a field within the tuple.
|
void |
TdbTextField.setValue(int index,
java.lang.String val)
Set the value of a specific paragraph to that provided.
|
void |
TdbTuple.setValue(java.lang.String fieldName,
java.lang.String val)
Set the value of a field within the tuple.
|
void |
TdbGraphRecord.setWeight(double weight)
Set the weight value for an edge record.
|
void |
TdbRecordSet.update(TdbRecord values)
Apply the same update transformation to all records covered by the record set
This method causes network I/O. |
abstract java.util.List<java.lang.String> |
TdbField.values()
Retrieve the current content of the field.
|
java.util.List<java.lang.String> |
TdbStringField.values()
Not supported for STring fields
|
Constructor and Description |
---|
TdbGraphRecord(TdbSession session)
Constructor, creates a blank graph record container.
|
TdbGraphRecord(TdbSession session,
java.lang.String name)
Constructor, associates the record with the named graph database.
|
TdbGraphRecord(TdbSession session,
TdbDatabaseDesign design)
Constructor, associates the graph record with the provided database design.
|
TdbGridRecord(TdbSession session)
Constructor, creates a blank record container
|
TdbGridRecordSet(TdbSession session)
Constructor, creates a blank instance
|
TdbHighlightRendition(java.lang.String stringFieldName,
java.lang.String textFieldName,
java.lang.String filenameFieldName,
TdbRenditionType type)
Constructor, create a fully specified template field.
|
TdbHighlightRendition(java.lang.String stringFieldName,
java.lang.String textFieldName,
TdbRenditionType type)
Constructor, create a fully specified template field.
|
TdbRecord(TdbSession session)
Constructor, creates a blank record container
|
TdbRecord(TdbSession session,
java.lang.String name,
boolean createFields)
Constructor, associates the new instance with the named database or thesaurus
|
TdbRecord(TdbSession session,
TdbControlObject ob,
boolean createFields)
Constructor, associates the new instance with the item referenced by
the provided Control object
|
TdbRecord(TdbSession session,
TdbDatabaseDesign design,
boolean createFields)
Constructor, associates the new instance with the design provided.
|
TdbRecordSet(TdbSession session)
Constructor, creates a blank instance
|
TdbSearch(TdbSession session)
Constructor, creates a blank instance.
|
TdbTupleList(TdbSession session,
TdbComponent cmp,
java.lang.String strFieldList)
Create a new tuple list.
|
TdbXmlRecord(TdbSession session)
Constructor, creates a blank TRIPxml record container.
|
TdbXmlRecord(TdbSession session,
java.lang.String name,
boolean createFields)
Constructor, associates the record with thenamed TRIPxml database.
|
TdbXmlRecord(TdbSession session,
TdbDatabaseDesign design,
boolean createFields)
Constructor, associates the record with the provided database design.
|
Modifier and Type | Method and Description |
---|---|
void |
TdbDatabaseDesign.addForeignKey(java.lang.String key,
java.lang.String linkdb,
java.lang.String linkfld,
TdbIntegrityType on_update,
TdbIntegrityType on_delete)
Create a foreign key relationship between this database (as the slave) and
another database (as the master).
|
void |
TdbDatabaseClusterDesign.changeMgr(java.lang.String newmgr)
Transfer all objects from the current user to a new manager.
|
void |
TdbDatabaseDesign.changeMgr(java.lang.String newmgr)
Transfer ownership of all databases from the calling user to another.
|
void |
TdbDatabaseClusterDesign.changeMgr(java.lang.String newmgr,
java.lang.String oldmgr)
Transfer all objects from one manager to another.
|
void |
TdbDatabaseDesign.changeMgr(java.lang.String newmgr,
java.lang.String oldmgr)
Transfer ownership of all databases from one user to another.
|
void |
TdbDatabaseClusterDesign.changeMgr(java.lang.String newmgr,
java.lang.String oldmgr,
java.lang.String name)
Transfer ownership of one or more cluster designs from one user to another.
|
void |
TdbDatabaseDesign.changeMgr(java.lang.String newmgr,
java.lang.String oldmgr,
java.lang.String name)
Transfer ownership of one or more database objects from one user
to another.
|
void |
TdbDatabaseDesign.compress(TdbCompressionContext ctx,
boolean all)
Requests a database compression operation, akin to the command line utility PACKIT.
|
void |
TdbDatabaseClusterDesign.copy(java.lang.String newname,
TdbControlObject newobj)
Copy the current cluster definition to a new name.
|
void |
TdbDatabaseDesign.copy(java.lang.String newname,
TdbControlObject newobj)
Create a shallow copy of the current database / thesaurus, preserving base design
but ignoring associated reports / forms, locations and access rights.
|
void |
TdbDatabaseClusterDesign.deepCopy(java.lang.String newname,
TdbControlObject newobj)
Create a deep copy of the current cluster under a new name.
|
void |
TdbDatabaseDesign.deepCopy(java.lang.String newname,
TdbControlObject newobj)
Create a deep copy of the current database / thesaurus, creating a new one that
is exactly the same, but with a different name (and correspondibly different
filenames on the server).
|
void |
TdbDatabaseClusterDesign.delete()
Delete the current cluster design from the server.
|
void |
TdbDatabaseDesign.delete()
Delete the current database from the server.
|
void |
TdbDatabaseClusterDesign.delete(java.lang.String name)
Delete the named cluster design from the server.
|
void |
TdbDatabaseDesign.delete(java.lang.String name)
Delete a named database from the server.
|
void |
TdbDatabaseDesign.deleteForeignKey(java.lang.String key)
Remove any existing foreign key relationship from the named field.
|
void |
TdbDatabaseDesign.deleteForeignKeys()
Removes all existing referential integrity rules from the database design.
|
void |
TdbDatabaseDesign.diagnose(TdbErrorCheckSink sink)
Check the database's primary data file (the BAF) for errors or conditions that
might cause errors in the future.
|
void |
TdbDatabaseDesign.diagnose(TdbErrorCheckSink sink,
int phase)
Check the database's primary data file (the BAF) for errors or conditions
that might cause errors in the future.
|
void |
TdbDatabaseClusterDesign.export(java.lang.String filename)
Export the current cluster definition to the named file.
|
void |
TdbDatabaseDesign.export(java.lang.String filename)
Exports the current database's design to the named file, including all
associated form definitions and file specifications.
|
void |
TdbDatabaseDesign.export(java.lang.String filename,
boolean full,
boolean incfiles)
Export the current database's design to the named file, optionally including
all associated form definitions.
|
void |
TdbDatabaseClusterDesign.export(java.lang.String filename,
java.lang.String name)
Export the named database cluster design to the named file.
|
void |
TdbDatabaseDesign.export(java.lang.String db,
java.lang.String filename,
boolean full,
boolean incfiles)
Export the named database's design to the named file, optionally including
all associated form definitions.
|
void |
TdbDatabaseClusterDesign.get()
Retrieve the current cluster's design from the server.
|
void |
TdbDatabaseDesign.get()
Retrieve the database design of the database referenced by the Control
object used to construct this object.
|
void |
TdbDatabaseClusterDesign.get(boolean resolve)
Retrieve the current cluster's design from the server.
|
void |
TdbDatabaseClusterDesign.get(java.lang.String name)
Retrieve the named cluster design from the server.
|
void |
TdbDatabaseDesign.get(java.lang.String name)
Retrieve the named database design and all associated properties.
|
void |
TdbDatabaseAccess.get(java.lang.String ug)
Retrieve the named user's (or group's) access rights for the current database, i.e.
|
void |
TdbDatabaseClusterDesign.get(java.lang.String name,
boolean resolve)
Retrieve the named cluster design from the server.
|
void |
TdbDatabaseAccess.get(java.lang.String db,
java.lang.String ug)
Retrieve the named user's (or group's) access rights for the named
database, thesaurus or cluster.
|
java.util.List<TdbFieldDesign> |
TdbDatabaseClusterDesign.getCommonFields()
Return a list of fields common to all databases in the cluster.
|
java.util.List<TdbFieldDesign> |
TdbDatabaseClusterDesign.getCommonFields(java.lang.String name)
Return a list of fields common to all databases in the cluster.
|
TdbControlObjectList |
TdbDatabaseDesign.getEntryForms()
Retrieve the list of TRIPclassic entry forms defined for the database
|
TdbFieldDesign |
TdbDatabaseDesign.getFieldById(int id)
Retrieve a reference to the design for a field with the specified field number.
|
TdbFieldDesign |
TdbDatabaseDesign.getFieldByIndex(int index)
Retrieve the n'th field within the database design.
|
java.util.List<TdbDatabaseDesign> |
TdbDatabaseClusterDesign.getMemberDesigns()
Return a list of database design objects for all databases in the
cluster, with nested clusters resolved.
|
java.util.List<TdbDatabaseDesign> |
TdbDatabaseClusterDesign.getMemberDesigns(java.lang.String name)
Return a list of database design objects for all databases in the
cluster, with nested clusters resolved.
|
TdbControlObjectList |
TdbDatabaseDesign.getOutputFormats()
Retrieve the list of avaiable output formats defined for the database
|
void |
TdbDatabaseClusterDesign.importCluster(java.lang.String filename,
java.lang.String name)
Import a new cluster design from the named file.
|
void |
TdbDatabaseDesign.importDesign(java.lang.String filename,
java.lang.String name)
Import a new database or thesaurus design from a named file.
|
void |
TdbDatabaseClusterDesign.importUpdate(java.lang.String filename)
Import an update to the current cluster design from the named file.
|
void |
TdbDatabaseDesign.importUpdate(java.lang.String filename)
Import an update to the current database's / thesaurus' design from a named file.
|
void |
TdbDatabaseClusterDesign.importUpdate(java.lang.String filename,
java.lang.String name)
Import an update to the named cluster design from the named file.
|
void |
TdbDatabaseDesign.importUpdate(java.lang.String filename,
java.lang.String name)
Import an update to an existing database / thesaurus from a named file.
|
void |
TdbDatabaseDesign.index()
Request a background task be submitted to index the current database.
|
void |
TdbDatabaseDesign.index(boolean reindex,
boolean batchjob)
Request the current database to be indexed.
|
void |
TdbDatabaseDesign.load(java.lang.String tform)
Request a background task to be submitted to load the named TFORM file
into the current database.
|
void |
TdbDatabaseDesign.loadAndIndex(java.lang.String tform)
Request a background task to be submitted to load and subsequently index the named TFORM file
into the current database.
|
void |
TdbDatabaseDesign.loadAndReindex(java.lang.String tform)
Request a background task to be submitted to load and subsequently reindex the named TFORM file
into the current database.
|
TdbControlObjectList |
TdbDatabaseClusterDesign.members()
Retrieve the current set of members in the cluster.
|
void |
TdbDatabaseClusterDesign.put()
Store the current cluster design to the server.
|
void |
TdbDatabaseDesign.put()
Store the current design to the server, including all associated properties.
|
void |
TdbDatabaseAccess.put()
Store the accumulated access rights; this call can only follow a successful call
to the
get method, as the database and user name established
during that call are used here. |
void |
TdbDatabaseClusterDesign.put(java.lang.String name)
Store a new or modified cluster design to the server.
|
void |
TdbDatabaseDesign.put(java.lang.String name)
Commit a new/updated database design to the server, including all associated
properties.
|
void |
TdbDatabaseAccess.put(java.lang.String db,
java.lang.String ug)
Store the accumulated access rights as the named user's (or group's) access privileges
for the named database, thesaurus or cluster
This method causes network I/O. |
void |
TdbDatabaseDesign.putField(TdbFieldDesign field)
Store a single modified field's properties to the server.
|
void |
TdbDatabaseDesign.putFields()
Store the current database's fields collection to the server.
|
void |
TdbDatabaseDesign.putProperties()
Store the general and indexing properties of the current design to the server.
|
void |
TdbDatabaseDesign.putProperties(java.lang.String db)
Store the general and indexing properties of the named design to the server.
|
void |
TdbDatabaseDesign.reindex()
Deprecated.
Use index(boolean,boolean) instead.
|
void |
TdbDatabaseClusterDesign.remove(java.lang.String db)
Remove a named member from the cluster.
|
void |
TdbDatabaseClusterDesign.remove(TdbControlObject ob)
Remove the referenced Control object member from this cluster.
|
void |
TdbDatabaseDesign.removeField(TdbFieldDesign field)
Remove a particular field from the current database design.
|
void |
TdbDatabaseClusterDesign.rename(java.lang.String newname)
Rename the current cluster design to a new name.
|
void |
TdbDatabaseDesign.rename(java.lang.String newname)
Rename the current database.
|
void |
TdbDatabaseClusterDesign.setMembers(TdbControlObjectList members)
Establish a new set of members in the cluster.
|
void |
TdbDatabaseDesign.status()
Refresh the status information of the current database.
|
void |
TdbDatabaseDesign.status(java.lang.String name)
Refresh the status information of the named database.
|
void |
TdbDatabaseDesign.validateField(TdbFieldDesign field)
Validate a particular field's design against the database design.
|
void |
TdbDatabaseDesign.validateRestriction(int type,
java.lang.String rest,
boolean pattern,
boolean fileref)
Attempt to validate that a restriction value is valid for a particular type
of field; this checks both the availability of the restriction type for that
field type, and the data type of the restriction.
|
Constructor and Description |
---|
TdbDatabaseAccess(TdbSession session)
Constructor, creates a blank container with no specific association
|
TdbDatabaseAccess(TdbSession session,
TdbControlObject ob)
Constructor, creates a blank container associated with a particular
database, thesaurus or cluster, as identified by the Control object
provided
|
TdbDatabaseAccess(TdbSession session,
TdbControlObjectProvider prv)
Constructor, creates a blank container associated with a particular
database, thesaurus or cluster as identified by the object that provides
a Control reference.
|
TdbDatabaseClusterDesign(TdbSession session)
Constructor, creates a new blank container
|
TdbDatabaseClusterDesign(TdbSession session,
TdbControlObject ob)
Constructor, creates a container for the cluster referenced by the
provided Control object
|
TdbDatabaseDesign(TdbSession session)
Constructor, creates a new, blank container
|
TdbDatabaseDesign(TdbSession session,
TdbControlObject ob)
Constructor, creates a container for the database referenced by the provided
Control object
|
TdbLocations(TdbSession session)
Creates a specialized view on the TRIP configuration that provides
file location definitions.
|
TdbThesaurusDesign(TdbSession session)
Constructor, creates a new, blank container
|
TdbThesaurusDesign(TdbSession session,
TdbControlObject ob)
Constructor, creates a container for the thesaurus referenced by the provided
Control object
|
Modifier and Type | Method and Description |
---|---|
void |
TdbFacetSet.get()
Retrieve the values for the facets in this facet set.
|
abstract TdbFacetValue |
TdbFacet.getValue(int index)
Retrieve a facet value object.
|
TdbFacetValue |
TdbFieldTermFacet.getValue(int index) |
TdbFacetValue |
TdbSearchFacet.getValue(int index) |
void |
TdbFacetSet.removeBaselines()
Removes all previously registered baseline data in the session.
|
void |
TdbFieldTermFacet.setMask(java.lang.String newMask)
Alter the search mask for the facet.
|
void |
TdbClassificationFacet.setSortOrder(TdbFacetSortOrder sortOrder) |
void |
TdbFacet.setSortOrder(TdbFacetSortOrder sortOrder)
Sets the sort order for the values of this facet.
|
void |
TdbSearchFacet.setSortOrder(TdbFacetSortOrder sortOrder)
Sets the sort order for the values of this facet.
|
Constructor and Description |
---|
TdbClassificationFacet(java.lang.String facetid)
Create a facet whose value set is TRIP's automatic classification.
|
TdbClassificationFacet(java.lang.String facetid,
java.lang.String mask)
Create a facet whose value set is TRIP's automatic classification.
|
TdbFacetSet(TdbSession session)
Create a new facet set
|
TdbFieldTermFacet(java.lang.String fieldname)
Create a facet based on a field in the currently open database
or in a search set.
|
TdbFieldTermFacet(java.lang.String fieldname,
java.lang.String mask)
Create a facet based on a field in the currently open database
|
TdbKvpFacet(java.lang.String namefield,
java.lang.String valuefield,
java.lang.String facetName)
Create a facet based on a key/value pair (KVP) display order, using
the values from one field as facet names, tupled with another field that
contains the facet values.
|
TdbKvpFacet(java.lang.String namefield,
java.lang.String valuefield,
java.lang.String facetName,
java.lang.String mask)
Create a facet based on a key/value pair (KVP) display order, using
the values from one field as facet names, tupled with another field that
contains the facet values.
|
Modifier and Type | Method and Description |
---|---|
void |
TdbFormat.copy(java.lang.String newdb,
java.lang.String newname,
TdbControlObject ob)
Copy the current format to a new database and new name.
|
void |
TdbFormat.create(java.lang.String frmname)
Create a new format with the specified name, of a type that doesn't require
a qualifying database name (e.g.
|
void |
TdbFormat.create(java.lang.String frmname,
java.lang.String dbname)
Create a new format with the specified name, for the specified database.
|
void |
TdbFormat.delete()
Remove the current form from the server; requires this object to have been created
using a TdbControlObject reference.
|
void |
TdbFormat.delete(java.lang.String frmname)
Delete a named format, which must be of a type that doesn't require a qualifying database.
|
void |
TdbFormat.delete(java.lang.String frmname,
java.lang.String dbname)
Delete a named format from a named database.
|
void |
TdbFormat.export(java.lang.String filename)
Export the current format definition to a named file.
|
void |
TdbFormat.export(java.lang.String filename,
java.lang.String frmname)
Export a format definition to a named file.
|
void |
TdbFormat.export(java.lang.String filename,
java.lang.String frmname,
java.lang.String dbname)
Export a format definition to a named file.
|
void |
TdbFormat.get()
Retrieve the content of the current form.
|
void |
TdbFormat.get(java.lang.String frmname)
Retrieve the content of a form from the server.
|
void |
TdbFormat.get(java.lang.String frmname,
java.lang.String dbname)
Retrieve the content of a form from the server.
|
java.lang.String |
TdbFormat.getDatabase()
Retrieve the name of the database or thesaurus with which this form is associated
|
void |
TdbFormat.importUpdate(java.lang.String filename)
Updates the current format with a definition read from a named file
This method causes network I/O. |
void |
TdbFormat.importUpdate(java.lang.String filename,
java.lang.String frmname)
Update a format with a definition read from a named file
This method causes network I/O. |
void |
TdbFormat.importUpdate(java.lang.String filename,
java.lang.String frmname,
java.lang.String dbname)
Update a format with a definition read from a named file
This method causes network I/O. |
void |
TdbFormat.put()
Store a potentially updated output format -- in order to make the commit stick, you
must have called one of the setXxx() methods first.
|
void |
TdbFormat.rename(java.lang.String newname)
Rename the format to the newly specified name
This method causes network I/O. |
void |
TdbFormat.setDatabase(java.lang.String db)
Establish the name of the database or thesaurus with which this form is associated
|
void |
TdbOutputFormat.test(TdbKernelWindow window)
Test the current format; this creates a temporary format on the server and attempts
to execute it.
|
Constructor and Description |
---|
TdbEntryForm(TdbSession session)
Constructor, creates a blank instance
|
TdbEntryForm(TdbSession session,
TdbControlObject ob)
Constructor, creates a format instance for the referenced Control object
|
TdbOutputFormat(TdbSession session)
Constructor, creates a blank instance
|
TdbOutputFormat(TdbSession session,
TdbControlObject ob)
Constructor, creates an output format instance for the provided Control object reference
|
TdbSearchForm(TdbSession session)
Constructor, creates a blank instance
|
TdbSearchForm(TdbSession session,
TdbControlObject ob)
Constructor, creates an instance for the format referenced by the provided Control object
|
Modifier and Type | Method and Description |
---|---|
TdbGraphSet |
TdbGraphSet.backtrack(java.lang.String edge,
int sourceSet)
Creates a subgraph by following a particular edge type backwards
from target vertex in the current graph set to source vertex in
the specified source set.
|
void |
TdbGraph.close()
Close this TdbGraph object and release all resources associated with it,
including search sets generated through its use.
|
TdbGraphRecord |
TdbGraph.createEdge(java.lang.String name,
int sourceRecordId,
int targetRecordId,
boolean commit)
Create an edge in the graph database currently associated with
this TdbGraph instance.
|
TdbGraphRecord |
TdbGraph.createEdge(java.lang.String name,
java.lang.String sourceDatabase,
int sourceRecordId,
java.lang.String targetDatabase,
int targetRecordId,
boolean commit)
Create an edge in the graph database currently associated with
this TdbGraph instance.
|
TdbGraphRecord |
TdbGraph.createEdge(java.lang.String name,
TdbRecord source,
TdbRecord target,
boolean commit)
Create an edge in the graph database currently associated with
this TdbGraph instance.
|
TdbGraphRecord |
TdbGraph.createVertex(java.lang.String label,
java.lang.String databaseName,
int recordId,
java.lang.String recordName,
boolean commit)
Create a vertex record in the graph database currently associated with
this TdbGraph instance.
|
TdbGraphRecord |
TdbGraph.createVertex(java.lang.String label,
TdbRecord reference,
boolean commit)
Create a vertex record in the graph database currently associated with
this TdbGraph instance.
|
TdbGraphPath[] |
TdbGraphSet.findPaths(int startSet,
java.lang.String[] edgeNames,
int targetSet,
int maxDepth,
boolean reverse)
Locate all paths associated with the current graph set that use vertices in
the specified start set as origins.
|
TdbGraphSet |
TdbGraphSet.follow(java.lang.String edge,
int targetSet)
Creates a subgraph by locating targets for the source vertices
in the current graph set such that they are related via a particular
edge (a.k.a.
|
TdbRecord |
TdbGraphPathVertex.getRecord(boolean createFields,
boolean retrieve)
Return a TdbRecord object for this graph vertex.
|
TdbGraphRecord |
TdbGraphSet.getRecord(int index)
Returns a TdbGraphRecord object for a record in the the current graph set.
|
TdbGraphSet |
TdbGraphSet.merge(TdbGraphSet otherSet)
Merge this graph set with another, producing the union of both sets.
|
TdbGraphQueryResult |
TdbGraphSet.query(java.lang.String expression)
Execute a query using the TRIP graph query language.
|
TdbSearchSet |
TdbGraphSet.resolveSources()
Resolve target vertices to a search set of the regular records they
represent.
|
TdbSearchSet |
TdbGraphSet.resolveTargets()
Resolve target vertices to a search set of the regular records they
represent.
|
TdbGraphPath |
TdbGraphSet.shortestPath(int startSet,
java.lang.String[] edgeNames,
int targetSet)
Determine the shortest path associated with the current graph set that use vertices in
the specified start set as origins.
|
TdbGraphSet |
TdbGraphSet.source(int searchSet)
Create a subgraph with edges where source vertices can be found
in the specified (regular) search set.
|
TdbGraphSet |
TdbGraphSet.target(int searchSet)
Create a subgraph with edges where target vertices can be found
in the specified (regular) search set.
|
TdbGraphSet |
TdbGraphSet.transitive(int sourceSet,
int targetSet,
java.lang.String[] edgeNames,
int maxDepth,
boolean reverse,
boolean allEdges)
Creates a subgraph of the current graph set where the specified source
and target records are connected via path.
|
Constructor and Description |
---|
TdbGraph(TdbSession session,
java.lang.String databaseOrCluster)
Opens a graph database or cluster of graph databases.
|
TdbGraph(TdbSession session,
TdbDatabaseDesign graphdb)
Opens a graph database.
|
TdbGraphNotification(TdbSession session)
Constructor
|
Modifier and Type | Method and Description |
---|---|
void |
TdbGridReplicaSet.create()
Create a new grid replica set -- this method uses the information from the
Control object provided during construction to create the replica set.
|
void |
TdbGridReplicaSet.create(java.lang.String name,
java.lang.String comment)
Create a new grid replica set.
|
void |
TdbGridCluster.create(java.lang.String name,
java.lang.String comment)
Create a new grid cluster.
|
void |
TdbGridHost.get()
Retrieve the properties of the grid host.
|
void |
TdbGridReplicaSet.get()
Retrieve the current replication set from the grid.
|
void |
TdbGridSysProps.get()
Retrieve the most recently written set of properties from the grid.
|
void |
TdbGridCluster.get()
Refresh the contents of the cluster from the grid.
|
void |
TdbGridReplicaSet.get(java.lang.String name)
Refresh the contents of the named replica set from the grid.
|
void |
TdbGridHost.put()
Store a new/modified host definition.
|
void |
TdbGridReplicaSet.put()
Store the contents of the replica set to the grid.
|
void |
TdbGridSysProps.put()
Store the current collection properties to the grid.
|
void |
TdbGridCluster.put()
Store the contents of the cluster to the grid.
|
void |
TdbGridHost.remove()
Remove the host from the grid.
|
void |
TdbGridReplicaSet.remove()
Delete an existing replica set -- this method uses the information from the
Control object provided during construction to name the replica set.
|
void |
TdbGridCluster.remove()
Remove the current cluster from the grid.
|
void |
TdbGridReplicaSet.remove(java.lang.String name)
Delete an existing replica set.
|
void |
TdbGridCluster.remove(java.lang.String name)
Remove a named cluster from the grid.
|
void |
TdbGridReplicaSet.rename(java.lang.String newname)
Rename an existing replica set.
|
void |
TdbGridCluster.rename(java.lang.String newname)
Rename an existing cluster.
|
Constructor and Description |
---|
TdbGridCluster(TdbSession session)
Constructor, creates a blank container for a new cluster
|
TdbGridCluster(TdbSession session,
TdbControlObject ob)
Constructor, creates a container for referencing the defined cluster
|
TdbGridClusterList(TdbSession session)
Constructor, retrieve a list of clusters
|
TdbGridHost(TdbSession session)
Constructor, creates a blank instance
|
TdbGridHost(TdbSession session,
java.lang.String name)
Constructor, creates an instance for the named host
|
TdbGridHostList(TdbSession session)
Constructor, retrieve a list of hosts that are publishing at least one database
to the grid
|
TdbGridReplicaSet(TdbSession session)
Constructor, creates a blank instance
|
TdbGridReplicaSet(TdbSession session,
TdbControlObject ob)
Constructor, creates an instance for the replica set referenced
|
TdbGridReplicaSetList(TdbSession session)
Constructor, retrieves the list of replica sets on the grid
|
TdbGridSysProps(TdbSession session)
Constructor, creates a blank properties collection
|
Modifier and Type | Method and Description |
---|---|
void |
TdbStreamLogger.log(java.lang.String prefix,
org.w3c.dom.Document doc) |
void |
TdbActivityLogger.log(java.lang.String prefix,
org.w3c.dom.Document doc)
Log a document to whatever underlying log mechanism is in use
|
Modifier and Type | Method and Description |
---|---|
TdbPooledSession |
TdbConnectionPool.acquire()
Acquire a session from the pool -- the first time a session is acquired,
it will incur the cost of a full login to the server.
|
TdbPooledSession |
TdbConnectionPool.acquire(long timeout)
Acquire a session from the pool -- the first time a session is acquired,
it will incur the cost of a full login to the server.
|
void |
TdbPoolInitializer.initializePooledSession(TdbPooledSession session)
Perform one-time initialization of a session when it is created by the
pool.
|
void |
TdbPooledSession.login(java.lang.String username,
java.lang.String password)
Invalid operation for a pooled session
|
void |
TdbPooledSession.login(java.lang.String username,
java.lang.String password,
TdbLanguage language,
boolean restart)
Invalid operation for a pooled session
|
void |
TdbPooledSession.logout()
Returns the session to the pool for reuse
|
void |
TdbPooledSession.logout(boolean save)
Returns the session to the pool for reuse
|
void |
TdbConnectionPool.reserve(int reserve)
Establish a reserve of sessions within the pool.
|
Constructor and Description |
---|
TdbTripNetConnectionPool(java.lang.String server,
int port,
java.lang.String inifile,
int timeout,
java.lang.String username,
java.lang.String password,
TdbLanguage lang,
int stepping)
Constructor -- setup the session pool with full TRIPnet parameters
|
TdbTripNetConnectionPool(java.lang.String server,
int port,
java.lang.String username,
java.lang.String password,
TdbLanguage lang,
int stepping)
Constructor -- setup the session pool with minimal TRIPnet parameters
|
TdbWebConnectionPool(java.lang.String server,
int port,
java.lang.String inifile,
int timeout,
java.lang.String username,
java.lang.String password,
TdbLanguage lang,
int stepping)
Constructor -- setup the session pool with full web parameters
|
TdbWebConnectionPool(java.lang.String server,
int port,
java.lang.String username,
java.lang.String password,
TdbLanguage lang,
int stepping)
Constructor -- setup the session pool with minimal web parameters
|
Modifier and Type | Method and Description |
---|---|
void |
TdbSession.authenticate(java.lang.String username,
java.lang.String password)
Authenticate with a grid.
|
void |
TdbSessionObject.cancel()
Cancel xml transaction
|
void |
TdbHostInterface.close()
Close the connection, release any associated resources
|
void |
TdbSession.enableNotification(TdbNotificationType type,
boolean enable)
Enables or disables notifications.
|
void |
TdbSession.enableNotification(TdbNotificationType type,
int notificationInterval)
Enables search and sort comforter notifications with a specified preferred interval.
|
java.util.Date |
TdbDateform.formatDate(java.lang.String value)
Parses a string with a TRIP DATE value into a Java Date.
|
java.util.Date |
TdbDateform.formatTimestamp(java.lang.String dateTimeValue)
Parses a string with a TRIP time stamp string (such as the lastUpdated
value for database designs available via TdbDatabaseDesign) into a
Java Date object.
|
java.util.Date |
TdbDateform.formatTimestamp(java.lang.String dateValue,
java.lang.String timeValue)
Parses a string with a TRIP DATE value and a string with a TRIP TIME
value into a single Java Date object.
|
TdbDateform |
TdbSession.getCurrentDateform()
Returns a TdbDateform instance for the current date format.
|
void |
TdbSession.login(java.lang.String username,
java.lang.String password)
Login to a TRIP server, using English CCL dialect, and disallowing restart.
|
void |
TdbSession.login(java.lang.String username,
java.lang.String password,
TdbLanguage language,
boolean restart)
Login to a TRIP server.
|
void |
TdbSession.logout()
Logout from the current session without saving state.
|
void |
TdbSession.logout(boolean save)
Logout from a session created with login.
|
void |
TdbBackgroundTaskSink.poll()
Poll the server for any updates
|
void |
TdbHostInterface.reconnect()
Shut down any existing connection and estalish a new one in place.
|
void |
TdbSessionObject.setCancelable(boolean cancelable)
Set cancelable state
|
void |
TdbSession.setNotificationSink(TdbNotificationSink sink)
Assign a notification sink.
|
abstract void |
TdbBackgroundTaskSink.taskCompleted()
This abstract method must be overridden in concrete instantiations of this
base class, and is called in the face of completion events from the server.
|
void |
TdbSession.validate(TdbInterfaceType type)
Validate that this session refers to a compatible connection type
|
void |
TdbSession.writeActivityLog(java.lang.String value)
Write an arbitrary string to the activity log (if any) associated with
this session
|
org.w3c.dom.Document |
TdbHostInterface.XmlApi(org.w3c.dom.Document request)
Perform an XML request, return an XML response
|
Constructor and Description |
---|
TdbGridSession(java.lang.String server,
int port)
Constructor
|
TdbLocalSession()
Constructor
|
TdbNotificationSink(TdbSession session)
Constructor, creates a notification sink with default, no-op
handlers.
|
TdbSerializableObject(TdbSession session,
TdbInterfaceType type,
TdbControlObject ob)
Constructor
|
TdbTripNetSession(java.lang.String server,
int port)
Constructor
|
TdbTripNetSession(java.lang.String server,
int port,
boolean encrypt)
Constructor
|
TdbTripNetSession(java.lang.String server,
int port,
java.lang.String inifile,
int timeout)
Constructor
|
TdbTripNetSession(java.lang.String server,
int port,
java.lang.String inifile,
int timeout,
boolean encrypt)
Constructor
|
TdbWebSession(java.lang.String server,
int port)
Constructor
|
TdbWebSession(java.lang.String server,
int port,
java.lang.String inifile,
int timeout)
Constructor, allows specification of optional server attributes
|
Modifier and Type | Method and Description |
---|---|
void |
TdbGroup.add(java.lang.String username)
Add a user to this group.
|
void |
TdbGroup.add(java.lang.String username,
java.lang.String groupname)
Add a user to a group.
|
void |
TdbGroup.changeMgr(java.lang.String newmgr)
Changes ownership of all items owned by the calling user to that defined by 'newmgr'.
|
void |
TdbUser.changeMgr(java.lang.String newmgr)
Move all objects owned by the current user to another user.
|
void |
TdbGroup.changeMgr(java.lang.String newmgr,
java.lang.String oldmgr)
Changes ownership of all items owned by 'oldmgr' to 'newmgr'.
|
void |
TdbUser.changeMgr(java.lang.String newmgr,
java.lang.String oldmgr)
Move all objects owned by one user to another user.
|
void |
TdbGroup.changeMgr(java.lang.String newmgr,
java.lang.String oldmgr,
java.lang.String name)
Move objects owned by one user to another user.
|
void |
TdbUser.changeMgr(java.lang.String newmgr,
java.lang.String oldmgr,
java.lang.String name)
Move objects owned by one user to another user.
|
void |
TdbUser.changePassword(java.lang.String oldpw,
java.lang.String newpw)
Change the current user's password.
|
void |
TdbUser.copy(java.lang.String newname,
java.lang.String newpw,
boolean groups,
TdbControlObject ob)
Create a new user as a copy of an existing one, optionally including group memberships
and private procedures.
|
void |
TdbProcedure.copy(java.lang.String newowner,
java.lang.String newname,
TdbControlObject newobject)
Copy the current procedure to a new owner, or to a new name under the same owner.
|
void |
TdbGroup.copy(java.lang.String newname,
TdbControlObject ob)
Copy the membership list of this group to a new group, creating the new group in
the process.
|
void |
TdbGroup.create()
Create a new user group -- the name of the group is taken from the
Control object provided when this TdbGroup instance was constructed.
|
void |
TdbGroup.create(java.lang.String groupname)
Create a new user group.
|
void |
TdbUser.create(java.lang.String username,
java.lang.String password)
Create a new user on the server with the specified credentials.
|
void |
TdbProcedure.create(java.lang.String owner,
java.lang.String name,
java.lang.String comment)
Create a new procedure.
|
void |
TdbGroup.delete()
Remove a group from the system -- the name of the group is taken from the
Control object provided when this TdbGroup instance was constructed.
|
void |
TdbProcedure.delete()
Delete the current stored procedure from the server.
|
void |
TdbUser.delete()
Remove the user from the server.
|
void |
TdbGroup.delete(java.lang.String groupname)
Remove a group from the system.
|
void |
TdbUser.delete(java.lang.String username)
Remove a user from the server.
|
void |
TdbProcedure.delete(java.lang.String owner,
java.lang.String name)
Delete a stored procedure from the server.
|
void |
TdbProcedure.export(java.lang.String filename)
Export the content of the current stored procedure to a named file.
|
void |
TdbUser.export(java.lang.String filename,
boolean groups)
Export the definition of the user to a file.
|
void |
TdbUser.export(java.lang.String filename,
java.lang.String username,
boolean groups)
Export the definition of the user to a file.
|
void |
TdbProcedure.export(java.lang.String filename,
java.lang.String owner,
java.lang.String name)
Export the content of the stored procedure to a named file.
|
void |
TdbGroup.exportGroup(java.lang.String filename,
boolean members,
boolean procedures)
Export the group's definition to a named file.
|
void |
TdbProcedure.get()
Retrieve the content of the current stored procedure from the server.
|
void |
TdbUser.get()
Retrieve the user's properties from the server.
|
void |
TdbUser.get(java.lang.String username)
Retrieve the specified user's properties from the server.
|
void |
TdbProcedure.get(java.lang.String owner,
java.lang.String name)
Retrieve the content of a stored procedure from the server.
|
void |
TdbGroup.importGroup(java.lang.String filename,
java.lang.String name)
Create a new group by importing a definition from a file.
|
void |
TdbProcedure.importProcedure(java.lang.String filename,
java.lang.String owner,
java.lang.String name)
Import a new procedure from a file.
|
void |
TdbGroup.importUpdate(java.lang.String filename)
Update the group's definition with a saved definition read from a file.
|
void |
TdbProcedure.importUpdate(java.lang.String filename)
Update the current procedure with a definition stored in a file.
|
void |
TdbUser.importUpdate(java.lang.String filename)
Update the user's definition from a saved file.
|
void |
TdbProcedure.importUpdate(java.lang.String filename,
java.lang.String owner,
java.lang.String name)
Update a procedure with a definition stored in file.
|
void |
TdbUser.importUser(java.lang.String filename,
java.lang.String username,
java.lang.String password)
Create a new user from a saved definition.
|
void |
TdbProcedure.put()
Save the current procedure to the server.
|
void |
TdbUser.put()
Update the user's properties on the server.
|
void |
TdbUser.put(java.lang.String username)
Update a user's properties on the server.
|
void |
TdbGroup.remove(java.lang.String username)
Remove a user from this group.
|
void |
TdbGroup.remove(java.lang.String username,
java.lang.String groupname)
Remove a user from a group.
|
void |
TdbGroup.rename(java.lang.String newname)
Rename the group.
|
void |
TdbProcedure.rename(java.lang.String newname)
Rename the procedure maintaining the current owner.
|
void |
TdbUser.rename(java.lang.String newname)
Rename the user.
|
void |
TdbUser.resetPassword(java.lang.String password)
Reset the user's password -- can only be accomplished by the system manager.
|
void |
TdbProcedure.saveSearch(int searchSetNumber,
java.lang.String owner,
java.lang.String name,
java.lang.String comment)
Save the CCL commands for a search set as a procedure.
|
Constructor and Description |
---|
TdbGroup(TdbSession session)
Constructor, creates a blank instance
|
TdbGroup(TdbSession session,
java.lang.String groupName)
Constructor, creates a group instance associated with the named group
|
TdbGroup(TdbSession session,
TdbControlObject ob)
Constructor, creates a group instance associated with the group referenced by the provided object
|
TdbProcedure(TdbSession session)
Constructor, creates a blank instance.
|
TdbProcedure(TdbSession session,
TdbControlObject ob)
Constructor, creates a container for the referenced stored procedure.
|
TdbUser(TdbSession session)
Constructor, creates a blank instance
|
TdbUser(TdbSession session,
TdbControlObject ob)
Constructor, creates a user instance for the user referenced by the provided Control object
|