public class TdbCclCommand extends TdbMessageProvider implements com.tietoenator.trip.jxp.internal.utils.DOMSink
Constructor and Description |
---|
TdbCclCommand(TdbSession session)
Constructor, creates a blank instance ready for command execution
|
Modifier and Type | Method and Description |
---|---|
void |
checkPoint()
Set a checkpoint in the execution sequence to which the session can later
be rolled-back.
|
void |
execDirect(java.lang.String command)
Execute a CCL command.
|
void |
execXPath(java.lang.String xpathStatement)
Execute a query in XPath syntax.
|
TdbKernelWindow |
getAffectedWindow()
If the command executed resulted in one of the kernel buffers being updated, this
method will return the kernel window structure appropriate.
|
TdbCclCommandType |
getCommandType()
Retrieve the type of command executed, at a very broad level.
|
java.lang.String |
getCurrentBase()
Retrieve the currently open database name
|
java.lang.String |
getCurrentThesaurusDef()
Returns the definition string used for the currently defined thesaurus,
or an empty string if no thesaurus is defined.
|
java.lang.String |
getCurrentThesaurusName()
Returns the name of the currently defined thesaurus, or an empty
string if no thesaurus is defined.
|
java.lang.String |
getDidYouMean()
Returns a "did-you-mean" suggestion for the command just executed.
|
java.lang.String |
getParsedCcl()
Retrieve the parsed version of the command submitted
|
TdbTermList |
getTermList()
Retrieve the instance of TdbTermList that is being used to handle the
results of non-hierarchical Display commands
|
int |
getTermListTimeout()
Get timeout for on-demand term lists generated by future DISPLAY commands..
|
TdbTermTree |
getTermTree()
Retrieve the instance of TdbTermTree that is being used to handle the
results of hierarchical (i.e.
|
boolean |
getUseOnDemandTermLists()
Returns true if term lists created via this TdbCclCommand instance
have values that are fetched on demand and are possible to use
concurrently.
|
java.util.List<TdbHistoryDetail> |
historyUpdates()
If the command executed resulted in one or more history updates, this method
will return an Iterator over a collection of detailed information, one entry
for each history update.
|
void |
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 |
rollbackToCheckPoint()
Rollback the query session to a previously established check point
Invoking this method causes network I/O.
|
void |
setTermList(TdbTermList terms)
Establish the instance of TdbTermList that should be used to handle the
results of non-hierarchical Display commands
|
void |
setTermListTimeout(int seconds)
Set timeout for on-demand term lists generated by future DISPLAY commands.
|
void |
setTermTree(TdbTermTree tree)
Establish the instance of TdbTermTree that should be used to handle the
results of hierarchical (i.e.
|
void |
setUseOnDemandTermLists(boolean enable)
Enable or disable the use of the on-demand term list feature.
|
codeList, getLastCode, getLastMessage, hasMessages, messageList, resetMessages
cancel, getSession, isCancelable, setCancelable
public TdbCclCommand(TdbSession session) throws TdbException
session
- Active sessionTdbException
public TdbCclCommandType getCommandType()
public java.lang.String getDidYouMean()
public java.lang.String getCurrentThesaurusName()
At least one CCL command that has caused the thesaurus definition to change or generated a search set must have been issued using this TdbCclCommand instance before thesaurus information is available.
This method requires TRIPsystem 8.0-2 or later.
public java.lang.String getCurrentThesaurusDef()
At least one CCL command that has caused the thesaurus definition to change or generated a search set must have been issued using this TdbCclCommand instance before thesaurus information is available.
This method requires TRIPsystem 8.0-2 or later.
public boolean getUseOnDemandTermLists()
TdbTripFeature.OnDemandTermLists
public void setUseOnDemandTermLists(boolean enable) throws TdbException
enable
- True to use on-demand term listsTdbException
- If on-demand term lists cannot be enabledTdbTripFeature.OnDemandTermLists
,
TdbCclCommand.setTermListTimeout(int)
public void setTermListTimeout(int seconds)
On-demand term lists requires resources on the server to keep alive. By default, they will time out in 120 seconds. After an on-demand term list has timed out, terms from it will no longer be possible to retrieve by the application without executing the DISPLAY order again.
Although it isn't always a good practise to do so, the timeout can be disabled by setting this value to zero.
seconds
- Timeout to setTdbCclCommand.setUseOnDemandTermLists(boolean)
public int getTermListTimeout()
On-demand term lists requires resources on the server to keep alive. By default, they will time out in 120 seconds. After an on-demand term list has timed out, terms from it will no longer be possible to retrieve by the application without executing the DISPLAY order again.
public java.util.List<TdbHistoryDetail> historyUpdates()
public TdbKernelWindow getAffectedWindow()
public java.lang.String getCurrentBase()
public java.lang.String getParsedCcl()
public TdbTermList getTermList()
public void setTermList(TdbTermList terms)
terms
- Term list handlerpublic TdbTermTree getTermTree()
public void setTermTree(TdbTermTree tree)
tree
- Term tree handlerpublic void checkPoint() throws TdbException
TdbException
public void rollbackToCheckPoint() throws TdbException
TdbException
public void mapKernelWindow(TdbKernelWindow window) throws TdbException
window
- A valid TdbKernelWindow referenceTdbException
public void execDirect(java.lang.String command) throws TdbException
command
- The command to be executedTdbException
public void execXPath(java.lang.String xpathStatement) throws TdbException
Successful use of this method requires that the currently open database is an XML database and that the server to which the current session is connected runs TRIPsystem 6.2-7 or later and TRIPxml 3.0 or later.
Invoking this method causes network I/O.
xpathStatement
- The XPath statement to be executed as a query.TdbException