Class Dynamic

java.lang.Object
  |
  +--Dynamic

All Implemented Interfaces:

CarFace

public class Dynamic

extends java.lang.Object

implements CarFace

Field Summary

static java.lang.String[]	activeFields
static int	COLLECTIONUPDATE
static Document	document
static int	DOCUMENTUPDATE
static int	GENERALUPDATE
static Collection	inCollection
static Collection[]	inCollections
static int	MATCH
static Collection	outCollection
static Collection[]	outCollections
static Document	outDoc
static Document	query
static boolean	scores receives scores (output requires scores) from Matcher (default true)
static Document	target
static double	threshold

Fields inherited from interface CarFace

BOOLEAN_LITERAL, COLLECTION, DOUBLE_LITERAL, EXTERNAL, grammarNames, INTERNAL, KEYPHRASE, LITERALcapacityIncrement, LITERALinitialCapacity, MARKUP, SERIAL, SESSION, STRING_LITERAL, STRINGVALUE_LITERAL

Constructor Summary

Dynamic()

Method Summary

void	clearCollection() Invoked by CollectionUpdate to indicate the current collection is finished with.
void	clearCollections() Invoked by GeneralUpdate to indicate the current collections are finished with.
void	clearDocument() Invoked by DocumentUpdate to indicate the current document is finished with.
void	clearMatcherDocs() Invoked by Matcher to indicate that current docs (target,query,outDoc) finished with.
java.lang.String	compile(java.lang.String source)
static void	deleteOutputDocument() Enables a user program performing a Match to request current output document to be ignored for output
void	engage(int processType) 'Engage' requested for a process (DocumentUpdate, CollectionUpdate, Match).
static java.lang.String[]	getActiveFields() Provides the input scores value (default true) to a user program performing a Match.
static Collection	getCollection() Provides the input collection to a user program performing a CollectionUpdate.
static Collection[]	getCollections() Provides the input collections to a user program performing a GeneralUpdate.
static Document	getDocument() Provides the next available document to a user program performing a DocumentUpdate.
int	getErrorLine()
java.lang.String	getErrorMess()
Collection	getOutCollectionFromProgram() Invoked by CollectionUpdate to return the collection created by a dynamic program.
Collection[]	getOutCollectionsFromProgram() Invoked by GeneralUpdate to return the collections created by a dynamic program.
Document	getOutDocumentFromProgram() Invoked by Matcher to get the output document created by user program (needed after user program has invoked Dynamic.deleteOutputDocument()
static Document	getOutputDocument() Provides the output document to a user program performing a Match.
static Document	getQueryDocument() Provides the query document to a user program performing a Match.
static boolean	getScores() Provides the input scores value (default true) to a user program performing a Match.
static Document	getTargetDocument() Provides the target document to a user program performing a Match.
static double	getThreshold() Provides the input threshold value (default 0.0) to a user program performing a Match.
void	putActiveFields(java.lang.String[] tags) Invoked by Matcher to make scores available to a dynamic program.
static void	putCollection(Collection docs) Makes the collection created by a user program performing a CollectionUpdate available to the action that executed the program
void	putCollectionForProgram(Collection docs) Invoked by CollectionUpdate to make a collection available to a dynamic program.
static void	putCollections(Collection[] outC) Makes the collection created by a user program performing a GeneralUpdate available to the action that executed the program
void	putCollectionsForProgram(Collection[] inCollections) Invoked by GeneralUpdate to make an array of collections available to a dynamic program.
void	putDocumentForProgram(Document doc) Invoked by DocumentUpdate to make a document available to a dynamic program.
void	putOutDocumentForProgram(Document doc) Invoked by Matcher to make an output document available to a dynamic program.
void	putQueryDocumentForProgram(Document doc) Invoked by Matcher to make a query document available to a dynamic program.
void	putScores(boolean b) Invoked by Matcher to make scores available to a dynamic program.
void	putTargetDocumentForProgram(Document doc) Invoked by Matcher to make a target document available to a dynamic program.
void	putThreshold(double d) Invoked by Matcher to make threshold available to a dynamic program.
void	release() A process is releasing Dynamic for other processes to use.
void	run()
java.lang.String	sourceToString()
static void	t(java.lang.String s) Provides trace output of string if -dDynamic on command line of CAR run

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DOCUMENTUPDATE

public static final int DOCUMENTUPDATE

COLLECTIONUPDATE

public static final int COLLECTIONUPDATE

GENERALUPDATE

public static final int GENERALUPDATE

MATCH

public static final int MATCH

document

public static Document document

inCollection

public static Collection inCollection

outCollection

public static Collection outCollection

inCollections

public static Collection[] inCollections

outCollections

public static Collection[] outCollections

target

public static Document target

query

public static Document query

outDoc

public static Document outDoc

threshold

public static double threshold

scores

public static boolean scores

receives scores (output requires scores) from Matcher (default true)

activeFields

public static java.lang.String[] activeFields

Constructor Detail

Dynamic

public Dynamic()

Method Detail

t

public static void t(java.lang.String s)

Provides trace output of string if -dDynamic on command line of CAR run

getDocument

public static Document getDocument()

Provides the next available document to a user program performing a DocumentUpdate.

getCollection

public static Collection getCollection()

Provides the input collection to a user program performing a CollectionUpdate.

putCollection

public static void putCollection(Collection docs)

Makes the collection created by a user program performing a CollectionUpdate available to the action that executed the program

getCollections

public static Collection[] getCollections()

Provides the input collections to a user program performing a GeneralUpdate.

putCollections

public static void putCollections(Collection[] outC)

Makes the collection created by a user program performing a GeneralUpdate available to the action that executed the program

getTargetDocument

public static Document getTargetDocument()

Provides the target document to a user program performing a Match.

getQueryDocument

public static Document getQueryDocument()

Provides the query document to a user program performing a Match.

getOutputDocument

public static Document getOutputDocument()

Provides the output document to a user program performing a Match.

getThreshold

public static double getThreshold()

Provides the input threshold value (default 0.0) to a user program performing a Match.

getScores

public static boolean getScores()

Provides the input scores value (default true) to a user program performing a Match.

getActiveFields

public static java.lang.String[] getActiveFields()

Provides the input scores value (default true) to a user program performing a Match.

deleteOutputDocument

public static void deleteOutputDocument()

Enables a user program performing a Match to request current output document to be ignored for output

engage

public void engage(int processType)

'Engage' requested for a process (DocumentUpdate, CollectionUpdate, Match). Only one process can engage Dynamic at a time ... so it might wait until an engaged process 'releases' before engaging this one.

release

public void release()

A process is releasing Dynamic for other processes to use.

putDocumentForProgram

public void putDocumentForProgram(Document doc)

Invoked by DocumentUpdate to make a document available to a dynamic program.

clearDocument

public void clearDocument()

Invoked by DocumentUpdate to indicate the current document is finished with.

putCollectionForProgram

public void putCollectionForProgram(Collection docs)

Invoked by CollectionUpdate to make a collection available to a dynamic program.

getOutCollectionFromProgram

public Collection getOutCollectionFromProgram()

Invoked by CollectionUpdate to return the collection created by a dynamic program.

clearCollection

public void clearCollection()

Invoked by CollectionUpdate to indicate the current collection is finished with.

putCollectionsForProgram

public void putCollectionsForProgram(Collection[] inCollections)

Invoked by GeneralUpdate to make an array of collections available to a dynamic program.

getOutCollectionsFromProgram

public Collection[] getOutCollectionsFromProgram()

Invoked by GeneralUpdate to return the collections created by a dynamic program.

clearCollections

public void clearCollections()

Invoked by GeneralUpdate to indicate the current collections are finished with.

putTargetDocumentForProgram

public void putTargetDocumentForProgram(Document doc)

Invoked by Matcher to make a target document available to a dynamic program.

putQueryDocumentForProgram

public void putQueryDocumentForProgram(Document doc)

Invoked by Matcher to make a query document available to a dynamic program.

putOutDocumentForProgram

public void putOutDocumentForProgram(Document doc)

Invoked by Matcher to make an output document available to a dynamic program.

getOutDocumentFromProgram

public Document getOutDocumentFromProgram()

Invoked by Matcher to get the output document created by user program (needed after user program has invoked Dynamic.deleteOutputDocument()

putThreshold

public void putThreshold(double d)

Invoked by Matcher to make threshold available to a dynamic program.

putScores

public void putScores(boolean b)

Invoked by Matcher to make scores available to a dynamic program.

putActiveFields

public void putActiveFields(java.lang.String[] tags)

Invoked by Matcher to make scores available to a dynamic program.

clearMatcherDocs

public void clearMatcherDocs()

Invoked by Matcher to indicate that current docs (target,query,outDoc) finished with.

compile

public java.lang.String compile(java.lang.String source)

getErrorLine

public int getErrorLine()

sourceToString

public java.lang.String sourceToString()

getErrorMess

public java.lang.String getErrorMess()

run

public void run()