List of functions

Description of functions
-----------------------------------------------------------------------------------------------------------------------------------------------------------

new
We have to initiate dmmFTS.x32 before the first use.

Example - Director
global doc
openXlib the pathName&"dmmFTS.x32"
doc=new(xtra "dmmFTS")

If the library dmmFTS.x32 is located in the XTRA folder, it is enough to command
global doc
doc=new(xtra "dmmFTS")

Example - Authorware
doc:=NewObject("dmmFTS")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=ftsRegistration( name: string, code:string)
This function has to be called before the first use of the XTRA dmmFTS.x32 immediately after initialization. Unless the right registration name and number are inserted an announcement "this is a demo version" will appear after initialization of the application and only the first 10 searched documents will be screened, another announcement "demo version" will appear for the rest.

Parametres
Type of name is string, for the demo version name = "dmm".
Type of code is string, for the demo version code= "demo". The chain for commercial version is unique.
To register the user will receive parameters code and name.

Very important
For safety reasons incorrect parameters can be only inserterted 3 times in the function registration. If you insert incorrect parameters name and code more times the registration is blocked and the XTRA will not work. You will be informed about it by a dialogue window. In this case you´ve got to restart Director or Authorware.

Note: Parameters name="dmm" and code="demo" are not considered as incorrect.

Example - Director
global doc
doc.ftsRegistration("dmm", "demo")

Example - Authorware
CallObject(doc; "ftsRegistration"; "dmm"; "demo")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

string=ftsErrorMsg()
The function gives text of the error that occured during your work with dmmFTS. If an operation goes smoothly an empty chain is given.

Parametres
There are no parametres in this function.

Example - Director
global doc
doc.ftsOpenIndex(the pathName&"dmm.fts")
error=doc.ftsErrorMsg()
if error="" then ftsDoc=doc.ftsSearch("demo and score")

Example - Authorware
error:=CallObject(doc; "ftsErrorMsg")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

boolean=ftsIsNoError()
The function gives back true, if no error occured during an operation. If an error occurs the function gives back false.

Parametres
There are no parametres in this function.

Example - Director
global doc
doc.ftsOpenIndex(the pathName&"data.fts")
if doc.ftsIsNoError() then
  ....
end if

Example - Authorware
error:=CallObject( doc; "ftsIsNoError")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=ftsErrorDialog(dialog: boolean)
Using this function we can set whether a dialogue window, showing error statement appears at the moment of an error or not. This setting only functions in Autor mode and it simplifies the application debugging. If you decide not to set the dialogue window you can check the errors using the function ftsErrorMsg().

Parametres
Dialog is the only parameter of the function, whose type is boolean. If the value is true, the dialogue window with error statement is opened with every error in the XTRA. For the parameter value false the window is not shown. Default setting is dialog=false.

Example - Director
global doc
doc.ftsErrorDialog(true)

Example - Authorware
CallObject(doc; "ftsErrorDialog"; true)

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=ftsErrorLog(logFile: string, logSave: boolean)
Using this function we can set whether an error is saved to text log file at the time of the error or not. This setting only functions in Autor mode and it simplifies the application debugging.

Parametres
The function has two parametres. The parameter logFile represents name of the log file that we want to save the errors to. Type of the logSave parametre is boolean. If its value is true, every error in the XTRA is saved to log file. If its value is false nothing will be saved. Default setting is logSave=false.

Example - Director
global doc
doc.ftsErrorLog(the pathName&"log.txt", true)

Example - Authorware
CallObject(doc; ftsErrorLog; FileLocation ^ "log.txt"; true)

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=ftsOpenIndex(file:string)
The function opens a fulltext index fts for the fulltext searching. Unless the fulltext index is open, it is not possible to use the fulltext searching.

Parametres
Type of file is string and one inserts here the name of an fts including the path.

Example - Director
global doc
doc.ftsOpenIndex(the pathName&"data.fts")

Example - Authorware
CallObject(doc; "ftsOpenIndex"; FileLocation ^ "data.fts")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=ftsCloseIndex()
This function closes and fineshes your work with the fulltext indexer.

Parametry
There are no parametres in this function.

Example - Director
global doc
doc.ftsCloseIndex()

Example - Authorware
CallObject(doc; "ftsCloseIndex")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

string=ftsVersion()
The function gives XTRA dmmFTS.x32 version number.

Parametres
There are no parametres in this function.

Example - Director
global doc
version=doc.ftsVersion()

Example - Authorware
version:=CallObject(doc; "ftsVersion")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

string=ftsIndexerName()
The function gives name of the indexer that has built the fulltext index file.

Parametres
There are no parametres in this function.

Example - Director
global doc
indexerName=doc.ftsIndexerName()

Example - Authorware
indexerName:=CallObject(doc; "ftsIndexerName")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

string=ftsIndexerVersion()
The function gives version of the indexer that has built the fulltext index file.

Parametres
There are no parametres in this function.

Example - Director
indexerVersion=doc.ftsIndexerVersion()

Example - Authorware
indexerVersion:=CallObject(doc; "ftsIndexerVersion")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

string=ftsIndexCreated()
The function gives date and time of fulltext index building.

Parametres
There are no parametres in this function.

Example - Director
global doc
dateTime=doc.ftsIndexCreated()

Example - Authorware
dateTime:=CallObject(doc; "ftsIndexCreated")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=ftsMaxRecordCount(max: integer)
The function sets the maximum number of searched documents. This limitation has to be used because sometimes the result is too many documents, which bear irrelevant information. Their Rang is too little.

Parametres
Type of max is integer and it represents the maximum number of documents, that we want to find.

Example - Director
global doc
doc.ftsMaxRecordCount(50)

Example - Authorware
CallObject(doc; "ftsMaxRecordCount" ; 50)

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=ftsRankMode(type: symbol)
The function sets how the value rank will be calculated. If we want to find out the value rank we have to take into consideration that the calculation will take certain time and the reply can thus be slower.

Parametres
The only parameter is type, whose type is symbol and it means the following:

Note
Defaultly set value in the XTRA is Type=#rankCount.

Example - Director
global doc
doc.ftsRankMode(#rankNone)

Example - Authorware
CallObject(doc; "ftsRankMode"; #rankNone)

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=ftsSearch(condition: string)
This functions makes the fulltext searching itself. After initialization of the ftsSearch function the database of searched documents is filled. We can work in this database using the function ftsFirst, ftsPrior, ftsNext, ftsLast and ftsMoveBy. We can read values from this database using the function ftsDocument.

Parametres
The easiest fulltext searching is an insertion of a single word. Avanced searching is to search a chain of words, incomplete words etc. Overview of logical operators, that can be used for the searching, as well as examples of use can be found in the table below.

void=ftsOrder(type: symbol, sort: symbol)
The function orders the searched document database.

Parametres
There are two parametres: Type of both, type and sort, is symbol and they mean the following:
Sort=#asc, the documents are in ascending order
Sort=#desc, the documents are in descending order

boolean=ftsBof()
The function gives true in case the actual record is the first record in the searched document database.
Otherwise it gives false.

Parametres
There are no parametres in this function.

Example - Director
global doc
if not doc.ftsBof() then
      ftsDoc=doc.ftsDocument()
end if

Example - Authorware
s:=CallObject(doc; "ftsBof")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

boolean=ftsEof()
The function gives true in case the actual record is the last record in the searched document database.
Otherwise it gives false.

Parametres
There are no parametres in this function.

Example - Director
global doc
if not doc.ftsEof() then
      ftsDoc=doc.ftsDocument()
end if

Example - Authorware
s:=CallObject(doc; "ftsEof")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=ftsFirst()
The function sets the first record in the searched document database to be the actual record.

Parametres
There are no parametres in this function.

Example - Director
global doc
doc.ftsFirst()

Example - Authorware
CallObject(doc; "ftsFirst")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=ftsPrior()
The function sets the previous record in the searched document database to be the actual record.

Parametres
There are no parametres in this function.

Example - Director
global doc
doc.ftsPrior()

Example - Authorware
CallObject(doc; "ftsPrior")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=ftsNext()
The function sets the next record in the searched document database to be the actual record.

Parametres
There are no parametres in this function.

Example - Director
global doc
doc.ftsNext()

Example - Authorware
CallObject(doc; "ftsNext")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=ftsLast()
The function sets the last record in the searched document database to be the actual record.

Parametres
There are no parametres in this function.

Example - Director
global doc
doc.ftsLast()

Example - Authorware
CallObject(doc; "ftsLast")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=ftsMoveBy(distance:integer)
The function jumps n records ahead or back in the searched document database.

Parametres
The only parameter is distance. The distance represents how many records in the database we want to move ahead or back. If the distance is >0, we move ahead if it is<0,we go back.
Example - Director
global doc
doc.ftsMoveBy(17)
doc.ftsMoveBy(-2)

Example - Authorware
CallObject(doc; ftsMoveBy"; 17)
CallObject(doc; ftsMoveBy"; -2)

-----------------------------------------------------------------------------------------------------------------------------------------------------------

boolean=ftsFind(id:integer)
The function jumps on the record in the database that is defined definitely by the id identificator. If the record can be found, the functions gives true. Otherwise it gives false.

Parametres
The parameter of the function is id, whose type is integer. Id of the appropriate record in the database is given by the function ftsDocument().

Example - Director
global doc
doc.ftsFind(7)

Example - Authorware
CallObject(doc; ftsFind"; 7)

-----------------------------------------------------------------------------------------------------------------------------------------------------------

integer=ftsRecordCount()
The function gives number of records in searched document database.

Parametres
There are no parametres in this function.

Example - Director
global doc
count=doc.ftsRecordCount()

Example - Authorware
count:=CallObject(doc; "RecordCount")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

integer=ftsRecordNo()
The function gives the serial number of the actual record in the searched document database.

Parametres
There are no parametres in this function.

Example - Director
global doc
number=doc.ftsRecordNo()

Example - Authorware
number:=CallObject(doc; "ftsRecordNo")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=ftsInsertBookmark(name: string)
The function creates and sets bookmark for the actual record of the database. In an application we can create a list of such bookmarks and then visit records that seemed somehow interesting to us.

Parametres
The parameter of the function is name, which represents name of the bookmark. This name must be unique. If we insert an already existing name, the exisiting bookmark will be rewritten.

Example - Director
global doc
doc.ftsInsertBookmark("test1")

Example - Authorware
CallObject(doc; "ftsInsertBookmark"; "test1")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=ftsGoToBookmark(name: string)
The function sets as actual record the record that is represented by the given bookmark.

Parametres
The parameter of the function is name, which represents name of the bookmark.

Example - Director
global doc
doc.ftsGoToBookmark("test1")

Example - Authorware
CallObject(doc; "ftsGoToBookmark"; "test1")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=ftsGetBookmarks()
The function gives a list of defined bookmarks in the Abstract Data Types format ["name1", "name2", "name3", ....]

Parametres
There are no parametres in this function.

Example - Director
global doc
listBookmarks=doc.ftsGetBookmarks()

Example - Authorware
listBookmarks:=CallObject(doc; "ftsGetBookmarks")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=ftsDeleteBookmark(name: string)
The function deletes a bookmark of the given name.

Parametres
The parameter of the function is name, which represents name of the bookmark.

Example - Director
global doc
doc.ftsDeleteBookmark("test1")

Example - Authorware
CallObject(doc; "ftsDeleteBookmark"; "test1")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=ftsClearBookmarks()
The functions deletes all created bookmarks.

Parametres
There are no parametres in this function.

Example - Director
global doc
doc.ftsClearBookmarks()

Example - Authorware
CallObject(doc; "ftsClearBookmarks")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

list=ftsDocument()
The function gives values of the actual record from the database of searched documents. Format of the values is Abstract Data Types. The way in which the dates are given depends on the used indexer.

Parametres
There are no parametres in this function.

Example - Director
global doc
ftsDoc=doc.ftsDocument()
put ftsDoc.memberName
put ftsDoc.castName
put ftsDoc.rank
put ftsDoc.size

Example - Authorware
ftsDoc:=CallObject(doc; "ftsDocument")
memberName:=ValueAtIndex(ftsDoc; 1)
castName:=ValueAtIndex(ftsDoc; 2)
rank:=ValueAtIndex(ftsDoc; 3)
size:=ValueAtIndex(ftsDoc; 4)

-----------------------------------------------------------------------------------------------------------------------------------------------------------

value=ftsGetFieldByName(fieldName: string)
The function returns value of the item of the database of the found documents, that is defined by its name.
The function returns the value in the format that the appropriate item in the databse is defined in.

Parametres
Parameter of the function is fieldName whose type is string and we insert here name of the item defined in the database. Description of the individual items is the same as in the function ftsDocument.

Example - Director
global doc
id=doc.ftsGetFieldByName("id")
title=doc.ftsGetFieldByName("title")
link=doc.ftsGetFieldByName("link")

Example - Authorware
id:=CallObject(doc; "ftsGetFieldByName"; "id")
title:=CallObject(doc; "ftsGetFieldByName"; "title")
link:=CallObject(doc; "ftsGetFieldByName"; "link")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

value=ftsGetFieldByNumber(fieldNo: string)
The function returns value of the item in the database of found documents, that is defined by its order in the database. The function returns the value in the format that the defined item has in the database.

Parametres
The function has a parameter being fieldNo whose type is integer and we insert here order of the item in the database. Description of individual items is identical as in the function ftsDocument.

Example - Director
global doc
id=doc.ftsGetFieldByNumber(1)
title=doc.ftsGetFieldByNumber(2)
link=doc.ftsGetFieldByNumber(3)

Example - Authorware
id:=CallObject(doc; "ftsGetFieldByNumber"; 1)
title:=CallObject(doc; "ftsGetFieldByNumber"; 2)
link:=CallObject(doc; "ftsGetFieldByNumber"; 3)