org.rococoa.cocoa.searchkit
Interface SearchKitLibrary

All Superinterfaces:

Library

public interface SearchKitLibrary
extends Library

JNA Wrapper for library SearchKit
This file was autogenerated by JNAerator,
a tool written by Olivier Chafik that uses a few opensource projects..
For help, please visit NativeLibs4Java, Rococoa, or JNA.

Nested Class Summary

static class	SearchKitLibrary.__SKIndex
static class	SearchKitLibrary.__SKIndexDocumentIterator
static class	SearchKitLibrary.__SKSearch
static class	SearchKitLibrary.__SKSearchGroup
static class	SearchKitLibrary.__SKSearchResults
static class	SearchKitLibrary.__SKSummary
static interface	SearchKitLibrary.SKDocumentIndexState SKDocumentIndexState Summary: The indexing state of a document.
static interface	SearchKitLibrary.SKIndexType SKIndexType Summary: The possible index types for SearchKit indexes.
static interface	SearchKitLibrary.SKSearchResultsFilterCallBack SKSearchResultsFilterCallBack Summary: A callback function for hit testing during searching.
static interface	SearchKitLibrary.SKSearchType SKSearchType Discussion: The various search types you can use with SKSearchResultsCreateWithQuery.

Nested classes/interfaces inherited from interface com.sun.jna.Library

Library.Handler

Field Summary

static SearchKitLibrary	INSTANCE
static int	kSKSearchOptionDefault
static int	kSKSearchOptionFindSimilar
static int	kSKSearchOptionNoRelevanceScores
static int	kSKSearchOptionSpaceMeansOR

Fields inherited from interface com.sun.jna.Library

OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER

Method Summary

NativeLong	SKDocumentGetTypeID() SKDocumentGetTypeID() Summary: Returns the type identifier of the SKDocument type.
void	SKIndexClose(SearchKitLibrary.__SKIndex inIndex) SKIndexClose() Summary: Close the index.
boolean	SKIndexCompact(SearchKitLibrary.__SKIndex inIndex) SKIndexCompact() Summary: Attempts to defragment and compact the index.
HIServicesLibrary.__CFArray	SKIndexCopyDocumentIDArrayForTermID(SearchKitLibrary.__SKIndex inIndex, NativeLong inTermID) SKIndexCopyDocumentIDArrayForTermID() Summary: Gets the IDs of the documents containing a given term in an index.
void	SKIndexCopyDocumentRefsForDocumentIDs(SearchKitLibrary.__SKIndex inIndex, NativeLong inCount, NativeLongByReference inDocumentIDsArray, Pointer outDocumentRefsArray) SKIndexCopyDocumentRefsForDocumentIDs() Summary: Copies document references by way of document IDs in an index.
void	SKIndexCopyDocumentURLsForDocumentIDs(SearchKitLibrary.__SKIndex inIndex, NativeLong inCount, NativeLongByReference inDocumentIDsArray, PointerByReference outDocumentURLsArray) SKIndexCopyDocumentURLsForDocumentIDs() Summary: Copies document URLs by way of document IDs in an index.
void	SKIndexCopyInfoForDocumentIDs(SearchKitLibrary.__SKIndex inIndex, NativeLong inCount, NativeLongByReference inDocumentIDsArray, HIServicesLibrary.CFStringRef outNamesArray, NativeLongByReference outParentIDsArray) SKIndexCopyInfoForDocumentIDs() Summary: Copies document names and parent ids by way of document IDs in an index.
HIServicesLibrary.__CFArray	SKIndexCopyTermIDArrayForDocumentID(SearchKitLibrary.__SKIndex inIndex, NativeLong inDocumentID) SKIndexCopyTermIDArrayForDocumentID() Summary: Gets the IDs for the terms of a document in an index.
NativeLong	SKIndexDocumentIteratorGetTypeID() SKIndexDocumentIteratorGetTypeID() Summary: Returns the type identifier of the index iterator.
boolean	SKIndexFlush(SearchKitLibrary.__SKIndex inIndex) SKIndexFlush() Summary: Forces SearchKit to flush all caches associated with an index.
HIServicesLibrary.__CFDictionary	SKIndexGetAnalysisProperties(SearchKitLibrary.__SKIndex inIndex) SKIndexGetAnalysisProperties() Summary: Gets the text analysis properties of an index.
NativeLong	SKIndexGetDocumentCount(SearchKitLibrary.__SKIndex inIndex) SKIndexGetDocumentCount() Summary: Gets the total number of documents represented in an index.
NativeLong	SKIndexGetDocumentTermCount(SearchKitLibrary.__SKIndex inIndex, NativeLong inDocumentID) SKIndexGetDocumentTermCount() Summary: Gets the number of terms for a given document in an index.
NativeLong	SKIndexGetDocumentTermFrequency(SearchKitLibrary.__SKIndex inIndex, NativeLong inDocumentID, NativeLong inTermID) SKIndexGetDocumentTermFrequency() Summary: Gets the frequency of occurrences of a given term in a document.
int	SKIndexGetIndexType(SearchKitLibrary.__SKIndex inIndex)
NativeLong	SKIndexGetMaximumBytesBeforeFlush(SearchKitLibrary.__SKIndex inIndex) SKIndexGetMaximumBytesBeforeFlush() Summary: Gets the memory size limit for an index, measured in bytes.
NativeLong	SKIndexGetMaximumDocumentID(SearchKitLibrary.__SKIndex inIndex) SKIndexGetMaximumDocumentID() Summary: Gets the highest-numbered document ID in an index.
NativeLong	SKIndexGetMaximumTermID(SearchKitLibrary.__SKIndex inIndex) SKIndexGetMaximumTermID() Summary: Gets the highest-numbered term ID in an index.
NativeLong	SKIndexGetTermDocumentCount(SearchKitLibrary.__SKIndex inIndex, NativeLong inTermID) SKIndexGetTermDocumentCount() Summary: Gets the number of documents containing a given term in an index.
NativeLong	SKIndexGetTypeID() SKIndexGetTypeID() Summary: Returns the type identifier for the index.
void	SKIndexSetMaximumBytesBeforeFlush(SearchKitLibrary.__SKIndex inIndex, NativeLong inBytesForUpdate) SKIndexSetMaximumBytesBeforeFlush() Summary: Sets the memory size limit for an index.
void	SKLoadDefaultExtractorPlugIns() SKLoadDefaultExtractorPlugIns() Summary: Loads the default text extractor plug-ins.
void	SKSearchCancel(SearchKitLibrary.__SKSearch inSearch) SKSearchCancel() Summary: Cancel the search request.
boolean	SKSearchFindMatches(SearchKitLibrary.__SKSearch inSearch, NativeLong inMaximumCount, NativeLongByReference outDocumentIDsArray, FloatBuffer outScoresArray, double maximumTime, NativeLongByReference outFoundCount) SKSearchFindMatches() Summary: Search for up to maximumTime seconds or until inMaximumCount (or all) items are found.
boolean	SKSearchFindMatches(SearchKitLibrary.__SKSearch inSearch, NativeLong inMaximumCount, NativeLongByReference outDocumentIDsArray, FloatByReference outScoresArray, double maximumTime, NativeLongByReference outFoundCount) Deprecated. use the safer method SKSearchFindMatches(org.rococoa.cocoa.searchkit.SearchKitLibrary.__SKSearch, com.sun.jna.NativeLong, com.sun.jna.ptr.NativeLongByReference, java.nio.FloatBuffer, double, com.sun.jna.ptr.NativeLongByReference) instead
NativeLong	SKSearchGetTypeID() SKSearchGetTypeID() Summary: Returns the type identifier for the SKSearch type.
HIServicesLibrary.__CFArray	SKSearchGroupCopyIndexes(SearchKitLibrary.__SKSearchGroup inSearchGroup) SKSearchGroupCopyIndexes() *** DEPRECATED *** Summary: Gets the indexes for a search group.
SearchKitLibrary.__SKSearchGroup	SKSearchGroupCreate(HIServicesLibrary.__CFArray inArrayOfInIndexes) SKSearchGroupCreate() *** DEPRECATED *** Summary: Creates a search group as an array of references to indexes.
NativeLong	SKSearchGroupGetTypeID() SKSearchGroupGetTypeID() Summary: Returns the type identifier for the SKSearchGroup type.
HIServicesLibrary.__CFArray	SKSearchResultsCopyMatchingTerms(SearchKitLibrary.__SKSearchResults inSearchResults, NativeLong inItem) SKSearchResultsCopyMatchingTerms() *** DEPRECATED *** Summary: Gets the matching terms for the specified search result item index.
SearchKitLibrary.__SKSearchResults	SKSearchResultsCreateWithDocuments(SearchKitLibrary.__SKSearchGroup inSearchGroup, HIServicesLibrary.__CFArray inExampleDocuments, NativeLong inMaxFoundDocuments, Pointer inContext, SearchKitLibrary.SKSearchResultsFilterCallBack inFilterCallBack) SKSearchResultsCreateWithDocuments() *** DEPRECATED *** Summary: Finds documents similar to given example documents by searching the indexes in a search group.
NativeLong	SKSearchResultsGetCount(SearchKitLibrary.__SKSearchResults inSearchResults) SKSearchResultsGetCount() *** DEPRECATED *** Summary: Gets the total number of found items in a search.
NativeLong	SKSearchResultsGetInfoInRange(SearchKitLibrary.__SKSearchResults inSearchResults, CFRange.ByValue inRange, Pointer outDocumentsArray, PointerByReference outIndexesArray, FloatBuffer outScoresArray) SKSearchResultsGetInfoInRange() *** DEPRECATED *** Summary: Fills in requested results, returns number of items that were returned.
NativeLong	SKSearchResultsGetInfoInRange(SearchKitLibrary.__SKSearchResults inSearchResults, CFRange.ByValue inRange, Pointer outDocumentsArray, PointerByReference outIndexesArray, FloatByReference outScoresArray) Deprecated. use the safer method SKSearchResultsGetInfoInRange(org.rococoa.cocoa.searchkit.SearchKitLibrary.__SKSearchResults, org.rococoa.cocoa.corefoundation.CFRange.ByValue, com.sun.jna.Pointer, com.sun.jna.ptr.PointerByReference, java.nio.FloatBuffer) instead
NativeLong	SKSearchResultsGetTypeID() SKSearchResultsGetTypeID() Summary: Returns the type identifier for the SKSearchResults object.
NativeLong	SKSummaryGetParagraphCount(SearchKitLibrary.__SKSummary summary) SKSummaryGetParagraphCount() Summary: Gets the number of paragraphs available.
NativeLong	SKSummaryGetParagraphSummaryInfo(SearchKitLibrary.__SKSummary summary, NativeLong numParagraphsInSummary, NativeLongByReference outRankOrderOfParagraphs, NativeLongByReference outParagraphIndexOfParagraphs) SKSummaryGetParagraphSummaryInfo() Summary: Get detailed information about a paragraph-based summary.
NativeLong	SKSummaryGetSentenceCount(SearchKitLibrary.__SKSummary summary) SKSummaryGetSentenceCount() Summary: Gets the number of sentences available.
NativeLong	SKSummaryGetSentenceSummaryInfo(SearchKitLibrary.__SKSummary summary, NativeLong numSentencesInSummary, NativeLongByReference outRankOrderOfSentences, NativeLongByReference outSentenceIndexOfSentences, NativeLongByReference outParagraphIndexOfSentences) SKSummaryGetSentenceSummaryInfo() Summary: Get detailed information about a sentence-based summary.
NativeLong	SKSummaryGetTypeID() SKSummaryGetTypeID() Summary: Returns the type identifier of the SKSummaryRef type.

Field Detail

INSTANCE

static final SearchKitLibrary INSTANCE

kSKSearchOptionDefault

static final int kSKSearchOptionDefault

See Also:

Constant Field Values

kSKSearchOptionNoRelevanceScores

static final int kSKSearchOptionNoRelevanceScores

See Also:

Constant Field Values

kSKSearchOptionSpaceMeansOR

static final int kSKSearchOptionSpaceMeansOR

See Also:

Constant Field Values

kSKSearchOptionFindSimilar

static final int kSKSearchOptionFindSimilar

See Also:

Constant Field Values

Method Detail

SKDocumentGetTypeID

NativeLong SKDocumentGetTypeID()

SKDocumentGetTypeID()

Summary:
Returns the type identifier of the SKDocument type.

Result:
Returns a CFTypeID object, or NULL on failure.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFTypeID SKDocumentGetTypeID()

SKIndexGetTypeID

NativeLong SKIndexGetTypeID()

SKIndexGetTypeID()

Summary:
Returns the type identifier for the index.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFTypeID SKIndexGetTypeID()

SKIndexDocumentIteratorGetTypeID

NativeLong SKIndexDocumentIteratorGetTypeID()

SKIndexDocumentIteratorGetTypeID()

Summary:
Returns the type identifier of the index iterator.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFTypeID SKIndexDocumentIteratorGetTypeID()

SKIndexFlush

boolean SKIndexFlush(SearchKitLibrary.__SKIndex inIndex)

SKIndexFlush()

Summary:
Forces SearchKit to flush all caches associated with an index.

Discussion:
Index caches can become stale when clients add or remove
documents. Before searching an index you need to call
SKIndexFlush, even though the cache flushing may take
some time.

Result:
Returns a Boolean value of true on success or
false on failure.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : Boolean SKIndexFlush(SKIndexRef)

SKIndexSetMaximumBytesBeforeFlush

void SKIndexSetMaximumBytesBeforeFlush(SearchKitLibrary.__SKIndex inIndex,
                                       NativeLong inBytesForUpdate)

SKIndexSetMaximumBytesBeforeFlush()

Summary:
Sets the memory size limit for an index.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : void SKIndexSetMaximumBytesBeforeFlush(SKIndexRef, CFIndex)

SKIndexGetMaximumBytesBeforeFlush

NativeLong SKIndexGetMaximumBytesBeforeFlush(SearchKitLibrary.__SKIndex inIndex)

SKIndexGetMaximumBytesBeforeFlush()

Summary:
Gets the memory size limit for an index, measured in bytes.

Result:
Returns a CFIndex object containing the memory size limit for an
index. On failure, returns 0.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFIndex SKIndexGetMaximumBytesBeforeFlush(SKIndexRef)

SKIndexCompact

boolean SKIndexCompact(SearchKitLibrary.__SKIndex inIndex)

SKIndexCompact()

Summary:
Attempts to defragment and compact the index.

Discussion:
This function takes time. Call it only when the index is too
fragmented. You can test for fragmentation be examining the ratio
of the total document count, obtained with
SKIndexGetDocumentCount, to the maximum document ID,
obtained with SKIndexGetMaximumDocumentID.

Result:
Returns a Boolean value of true on success or
false on failure.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : Boolean SKIndexCompact(SKIndexRef)

SKIndexGetIndexType

int SKIndexGetIndexType(SearchKitLibrary.__SKIndex inIndex)

See Also:

SearchKitLibrary.SKIndexType

SKIndexGetAnalysisProperties

HIServicesLibrary.__CFDictionary SKIndexGetAnalysisProperties(SearchKitLibrary.__SKIndex inIndex)

SKIndexGetAnalysisProperties()

Summary:
Gets the text analysis properties of an index.

Result:
Returns a CFDictionary object containing the index's text
analysis properties. On failure, returns NULL.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFDictionaryRef SKIndexGetAnalysisProperties(SKIndexRef)

SKIndexGetDocumentCount

NativeLong SKIndexGetDocumentCount(SearchKitLibrary.__SKIndex inIndex)

SKIndexGetDocumentCount()

Summary:
Gets the total number of documents represented in an index.

Discussion:
Indexed documents have an indexing state of
kSKDocumentStateIndexed. See the SKDocumentIndexState
enumeration.

Result:
Returns CFIndex object containing the number of documents in the
index. On failure, returns 0.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFIndex SKIndexGetDocumentCount(SKIndexRef)

SKIndexClose

void SKIndexClose(SearchKitLibrary.__SKIndex inIndex)

SKIndexClose()

Summary:
Close the index.

Availability:
Mac OS X: in version 10.4 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : void SKIndexClose(SKIndexRef)

SKIndexGetMaximumDocumentID

NativeLong SKIndexGetMaximumDocumentID(SearchKitLibrary.__SKIndex inIndex)

SKIndexGetMaximumDocumentID()

Summary:
Gets the highest-numbered document ID in an index.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : SKDocumentID SKIndexGetMaximumDocumentID(SKIndexRef)

SKIndexGetDocumentTermCount

NativeLong SKIndexGetDocumentTermCount(SearchKitLibrary.__SKIndex inIndex,
                                       NativeLong inDocumentID)

SKIndexGetDocumentTermCount()

Summary:
Gets the number of terms for a given document in an index.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFIndex SKIndexGetDocumentTermCount(SKIndexRef, SKDocumentID)

SKIndexCopyTermIDArrayForDocumentID

HIServicesLibrary.__CFArray SKIndexCopyTermIDArrayForDocumentID(SearchKitLibrary.__SKIndex inIndex,
                                                                NativeLong inDocumentID)

SKIndexCopyTermIDArrayForDocumentID()

Summary:
Gets the IDs for the terms of a document in an index.

Result:
A reference to a CFArray object containing CFNumber objects.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFArrayRef SKIndexCopyTermIDArrayForDocumentID(SKIndexRef, SKDocumentID)

SKIndexGetDocumentTermFrequency

NativeLong SKIndexGetDocumentTermFrequency(SearchKitLibrary.__SKIndex inIndex,
                                           NativeLong inDocumentID,
                                           NativeLong inTermID)

SKIndexGetDocumentTermFrequency()

Summary:
Gets the frequency of occurrences of a given term in a document.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFIndex SKIndexGetDocumentTermFrequency(SKIndexRef, SKDocumentID, CFIndex)

SKIndexGetMaximumTermID

NativeLong SKIndexGetMaximumTermID(SearchKitLibrary.__SKIndex inIndex)

SKIndexGetMaximumTermID()

Summary:
Gets the highest-numbered term ID in an index.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFIndex SKIndexGetMaximumTermID(SKIndexRef)

SKIndexGetTermDocumentCount

NativeLong SKIndexGetTermDocumentCount(SearchKitLibrary.__SKIndex inIndex,
                                       NativeLong inTermID)

SKIndexGetTermDocumentCount()

Summary:
Gets the number of documents containing a given term in an index.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFIndex SKIndexGetTermDocumentCount(SKIndexRef, CFIndex)

SKIndexCopyDocumentIDArrayForTermID

HIServicesLibrary.__CFArray SKIndexCopyDocumentIDArrayForTermID(SearchKitLibrary.__SKIndex inIndex,
                                                                NativeLong inTermID)

SKIndexCopyDocumentIDArrayForTermID()

Summary:
Gets the IDs of the documents containing a given term in an index.

Result:
A reference to a CFArray object containing CFNumber objects.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFArrayRef SKIndexCopyDocumentIDArrayForTermID(SKIndexRef, CFIndex)

SKLoadDefaultExtractorPlugIns

void SKLoadDefaultExtractorPlugIns()

SKLoadDefaultExtractorPlugIns()

Summary:
Loads the default text extractor plug-ins.

Discussion:
A text extractor knows the format of a specific kind of document.
For example, various text extractors can return the text of a PDF
document, strip the tags of an HTML document, and so on. Loading
extractors allows the SKIndexAddDocument function to
extract the text from supported documents, leaving the markup
behind.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : void SKLoadDefaultExtractorPlugIns()

SKSearchGroupGetTypeID

NativeLong SKSearchGroupGetTypeID()

SKSearchGroupGetTypeID()

Summary:
Returns the type identifier for the SKSearchGroup type.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFTypeID SKSearchGroupGetTypeID()

SKSearchResultsGetTypeID

NativeLong SKSearchResultsGetTypeID()

SKSearchResultsGetTypeID()

Summary:
Returns the type identifier for the SKSearchResults object.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFTypeID SKSearchResultsGetTypeID()

SKSearchGroupCreate

SearchKitLibrary.__SKSearchGroup SKSearchGroupCreate(HIServicesLibrary.__CFArray inArrayOfInIndexes)

SKSearchGroupCreate() *** DEPRECATED ***

Summary:
Creates a search group as an array of references to indexes.

Discussion:
A search group is used to search one or more indexes.

Parameters:

inArrayOfInIndexes:
A CFArray object containing SKIndex objects.

Result:
SKSearchGroupRef A reference to an SKSearchGroup opaque type.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework but deprecated in 10.4
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : SKSearchGroupRef SKSearchGroupCreate(CFArrayRef)

SKSearchGroupCopyIndexes

HIServicesLibrary.__CFArray SKSearchGroupCopyIndexes(SearchKitLibrary.__SKSearchGroup inSearchGroup)

SKSearchGroupCopyIndexes() *** DEPRECATED ***

Summary:
Gets the indexes for a search group.

Result:
A CFArray object containing SKIndex objects.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework but deprecated in 10.4
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFArrayRef SKSearchGroupCopyIndexes(SKSearchGroupRef)

SKSearchResultsCreateWithDocuments

SearchKitLibrary.__SKSearchResults SKSearchResultsCreateWithDocuments(SearchKitLibrary.__SKSearchGroup inSearchGroup,
                                                                      HIServicesLibrary.__CFArray inExampleDocuments,
                                                                      NativeLong inMaxFoundDocuments,
                                                                      Pointer inContext,
                                                                      SearchKitLibrary.SKSearchResultsFilterCallBack inFilterCallBack)

SKSearchResultsCreateWithDocuments() *** DEPRECATED ***

Summary:
Finds documents similar to given example documents by searching
the indexes in a search group. This call has been deprecated in
favor of SKSearchCreate.

Discussion:
A call to SKSearchResultsCreateWithDocuments must be balanced
with a call at a later time to CFRelease.

Parameters:

inSearchGroup:
A reference to the search group.

inExampleDocuments:
An array of example documents. The documents must previously
have been indexed.

inMaxFoundDocuments:
The maximum number of found items to return. Your client must
specify a positive value.

inContext:
A client-specified context. May be NULL.

inFilterCallBack:
A callback function for hit testing during searching. May be
NULL.

Result:
SKSearchResultsRef A reference to an SKSearchResults opaque type.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework but deprecated in 10.4
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : SKSearchResultsRef SKSearchResultsCreateWithDocuments(SKSearchGroupRef, CFArrayRef, CFIndex, void*, SKSearchResultsFilterCallBack)

SKSearchResultsGetCount

NativeLong SKSearchResultsGetCount(SearchKitLibrary.__SKSearchResults inSearchResults)

SKSearchResultsGetCount() *** DEPRECATED ***

Summary:
Gets the total number of found items in a search.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework but deprecated in 10.4
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFIndex SKSearchResultsGetCount(SKSearchResultsRef)

SKSearchResultsGetInfoInRange

@Deprecated
NativeLong SKSearchResultsGetInfoInRange(SearchKitLibrary.__SKSearchResults inSearchResults,
                                                    CFRange.ByValue inRange,
                                                    Pointer outDocumentsArray,
                                                    PointerByReference outIndexesArray,
                                                    FloatByReference outScoresArray)

Deprecated. use the safer method SKSearchResultsGetInfoInRange(org.rococoa.cocoa.searchkit.SearchKitLibrary.__SKSearchResults, org.rococoa.cocoa.corefoundation.CFRange.ByValue, com.sun.jna.Pointer, com.sun.jna.ptr.PointerByReference, java.nio.FloatBuffer) instead

SKSearchResultsGetInfoInRange() *** DEPRECATED ***

Summary:
Fills in requested results, returns number of items that were
returned.

Discussion:
Search results are returned in descending order of relevance
score.

Parameters:

inSearchResults:
A reference to the search results.

inRange:
A CFRange value pair, specified as (location, length). The
location value specifies the starting item by ranking. The
length value specifies the total number of items. Examples:
(0,1) means the first item, which is also the highest ranking
item. (1,1) means the second item, which is also the
second-highest ranking item. (0,5) means to get the first 5
items.

outDocumentsArray:
An array of found documents.

outIndexesArray:
An array of indexes in which the found docouments reside. May
be NULL provided that the client does not care.

outScoresArray:
An array of correspondence scores for found items. May be
NULL.

Result:
The number of items returned -- usually the same number as
specified.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework but deprecated in 10.4
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFIndex SKSearchResultsGetInfoInRange(SKSearchResultsRef, CFRange, SKDocumentRef*, SKIndexRef*, float*)

SKSearchResultsGetInfoInRange

NativeLong SKSearchResultsGetInfoInRange(SearchKitLibrary.__SKSearchResults inSearchResults,
                                         CFRange.ByValue inRange,
                                         Pointer outDocumentsArray,
                                         PointerByReference outIndexesArray,
                                         FloatBuffer outScoresArray)

SKSearchResultsGetInfoInRange() *** DEPRECATED ***

Summary:
Fills in requested results, returns number of items that were
returned.

Discussion:
Search results are returned in descending order of relevance
score.

Parameters:

inSearchResults:
A reference to the search results.

inRange:
A CFRange value pair, specified as (location, length). The
location value specifies the starting item by ranking. The
length value specifies the total number of items. Examples:
(0,1) means the first item, which is also the highest ranking
item. (1,1) means the second item, which is also the
second-highest ranking item. (0,5) means to get the first 5
items.

outDocumentsArray:
An array of found documents.

outIndexesArray:
An array of indexes in which the found docouments reside. May
be NULL provided that the client does not care.

outScoresArray:
An array of correspondence scores for found items. May be
NULL.

Result:
The number of items returned -- usually the same number as
specified.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework but deprecated in 10.4
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFIndex SKSearchResultsGetInfoInRange(SKSearchResultsRef, CFRange, SKDocumentRef*, SKIndexRef*, float*)

SKSearchResultsCopyMatchingTerms

HIServicesLibrary.__CFArray SKSearchResultsCopyMatchingTerms(SearchKitLibrary.__SKSearchResults inSearchResults,
                                                             NativeLong inItem)

SKSearchResultsCopyMatchingTerms() *** DEPRECATED ***

Summary:
Gets the matching terms for the specified search result item
index.

Parameters:

inSearchResults:
A reference to the search results.

inItem:
The search result item index, starting from 1.

Result:
A reference to a CFArray object of term IDs.

Availability:
Mac OS X: in version 10.3 and later in CoreServices.framework but deprecated in 10.4
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFArrayRef SKSearchResultsCopyMatchingTerms(SKSearchResultsRef, CFIndex)

SKSearchGetTypeID

NativeLong SKSearchGetTypeID()

SKSearchGetTypeID()

Summary:
Returns the type identifier for the SKSearch type.

Availability:
Mac OS X: in version 10.4 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFTypeID SKSearchGetTypeID()

SKSearchCancel

void SKSearchCancel(SearchKitLibrary.__SKSearch inSearch)

SKSearchCancel()

Summary:
Cancel the search request.

Availability:
Mac OS X: in version 10.4 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : void SKSearchCancel(SKSearchRef)

SKSearchFindMatches

@Deprecated
boolean SKSearchFindMatches(SearchKitLibrary.__SKSearch inSearch,
                                       NativeLong inMaximumCount,
                                       NativeLongByReference outDocumentIDsArray,
                                       FloatByReference outScoresArray,
                                       double maximumTime,
                                       NativeLongByReference outFoundCount)

Deprecated. use the safer method SKSearchFindMatches(org.rococoa.cocoa.searchkit.SearchKitLibrary.__SKSearch, com.sun.jna.NativeLong, com.sun.jna.ptr.NativeLongByReference, java.nio.FloatBuffer, double, com.sun.jna.ptr.NativeLongByReference) instead

SKSearchFindMatches()

Summary:
Search for up to maximumTime seconds or until inMaximumCount (or
all) items are found.

Discussion:
Returns TRUE if more to search, FALSE when the search is
exhausted. Returns number of entries actually found in
*outFoundCount. The maximumTime of 0 means return quickly, so may
return TRUE, and 0 outFoundCount. The relevance score is not
normalized, so it can be very large.

Parameters:

inSearch:
A reference to the SKSearch opaque type.

inMaximumCount:
The maximum number of found items to return.

outDocumentIDsArray:
An array of found document IDs. Must be inMaximumCount in size.

outScoresArray:
An array of relevance scores for found items. May be
NULL.

maximumTime:
The maximum seconds before return.

outFoundCount:
The number of items actually found.

Result:
Boolean Returns TRUE if more to search, FALSE when
the search is exhausted.

Availability:
Mac OS X: in version 10.4 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : Boolean SKSearchFindMatches(SKSearchRef, CFIndex, SKDocumentID*, float*, CFTimeInterval, CFIndex*)

SKSearchFindMatches

boolean SKSearchFindMatches(SearchKitLibrary.__SKSearch inSearch,
                            NativeLong inMaximumCount,
                            NativeLongByReference outDocumentIDsArray,
                            FloatBuffer outScoresArray,
                            double maximumTime,
                            NativeLongByReference outFoundCount)

SKSearchFindMatches()

Summary:
Search for up to maximumTime seconds or until inMaximumCount (or
all) items are found.

Discussion:
Returns TRUE if more to search, FALSE when the search is
exhausted. Returns number of entries actually found in
*outFoundCount. The maximumTime of 0 means return quickly, so may
return TRUE, and 0 outFoundCount. The relevance score is not
normalized, so it can be very large.

Parameters:

inSearch:
A reference to the SKSearch opaque type.

inMaximumCount:
The maximum number of found items to return.

outDocumentIDsArray:
An array of found document IDs. Must be inMaximumCount in size.

outScoresArray:
An array of relevance scores for found items. May be
NULL.

maximumTime:
The maximum seconds before return.

outFoundCount:
The number of items actually found.

Result:
Boolean Returns TRUE if more to search, FALSE when
the search is exhausted.

Availability:
Mac OS X: in version 10.4 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : Boolean SKSearchFindMatches(SKSearchRef, CFIndex, SKDocumentID*, float*, CFTimeInterval, CFIndex*)

SKIndexCopyInfoForDocumentIDs

void SKIndexCopyInfoForDocumentIDs(SearchKitLibrary.__SKIndex inIndex,
                                   NativeLong inCount,
                                   NativeLongByReference inDocumentIDsArray,
                                   HIServicesLibrary.CFStringRef outNamesArray,
                                   NativeLongByReference outParentIDsArray)

SKIndexCopyInfoForDocumentIDs()

Summary:
Copies document names and parent ids by way of document IDs in an
index.

Parameters:

inIndex:
A reference to the index.

inCount:
The number of inDocumentIDsArray.

inDocumentIDsArray:
An array of document IDs.

outNamesArray:
An array of names for the specified document IDs. May be
NULL.

outParentIDsArray:
An array of parent ids for the specified document IDs. May be
NULL.

Availability:
Mac OS X: in version 10.4 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : void SKIndexCopyInfoForDocumentIDs(SKIndexRef, CFIndex, SKDocumentID*, CFStringRef*, SKDocumentID*)

SKIndexCopyDocumentRefsForDocumentIDs

void SKIndexCopyDocumentRefsForDocumentIDs(SearchKitLibrary.__SKIndex inIndex,
                                           NativeLong inCount,
                                           NativeLongByReference inDocumentIDsArray,
                                           Pointer outDocumentRefsArray)

SKIndexCopyDocumentRefsForDocumentIDs()

Summary:
Copies document references by way of document IDs in an index.

Parameters:

inIndex:
A reference to the index.

inCount:
The number of inDocumentIDsArray.

inDocumentIDsArray:
An array of document IDs.

outDocumentRefsArray:
An array of document references for the specified document IDs.

Availability:
Mac OS X: in version 10.4 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : void SKIndexCopyDocumentRefsForDocumentIDs(SKIndexRef, CFIndex, SKDocumentID*, SKDocumentRef*)

SKIndexCopyDocumentURLsForDocumentIDs

void SKIndexCopyDocumentURLsForDocumentIDs(SearchKitLibrary.__SKIndex inIndex,
                                           NativeLong inCount,
                                           NativeLongByReference inDocumentIDsArray,
                                           PointerByReference outDocumentURLsArray)

SKIndexCopyDocumentURLsForDocumentIDs()

Summary:
Copies document URLs by way of document IDs in an index.

Parameters:

inIndex:
A reference to the index.

inCount:
The number of inDocumentIDsArray.

inDocumentIDsArray:
An array of document IDs.

outDocumentURLsArray:
An array of CFURLs for the specified document IDs.

Availability:
Mac OS X: in version 10.4 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : void SKIndexCopyDocumentURLsForDocumentIDs(SKIndexRef, CFIndex, SKDocumentID*, CFURLRef*)

SKSummaryGetTypeID

NativeLong SKSummaryGetTypeID()

SKSummaryGetTypeID()

Summary:
Returns the type identifier of the SKSummaryRef type.

Result:
Returns a CFTypeID object, or NULL on failure.

Availability:
Mac OS X: in version 10.4 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFTypeID SKSummaryGetTypeID()

SKSummaryGetSentenceCount

NativeLong SKSummaryGetSentenceCount(SearchKitLibrary.__SKSummary summary)

SKSummaryGetSentenceCount()

Summary:
Gets the number of sentences available.

Parameters:

summary:
A reference to the summary object

Availability:
Mac OS X: in version 10.4 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFIndex SKSummaryGetSentenceCount(SKSummaryRef)

SKSummaryGetParagraphCount

NativeLong SKSummaryGetParagraphCount(SearchKitLibrary.__SKSummary summary)

SKSummaryGetParagraphCount()

Summary:
Gets the number of paragraphs available.

Parameters:

summary:
A reference to the summary object

Availability:
Mac OS X: in version 10.4 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFIndex SKSummaryGetParagraphCount(SKSummaryRef)

SKSummaryGetSentenceSummaryInfo

NativeLong SKSummaryGetSentenceSummaryInfo(SearchKitLibrary.__SKSummary summary,
                                           NativeLong numSentencesInSummary,
                                           NativeLongByReference outRankOrderOfSentences,
                                           NativeLongByReference outSentenceIndexOfSentences,
                                           NativeLongByReference outParagraphIndexOfSentences)

SKSummaryGetSentenceSummaryInfo()

Summary:
Get detailed information about a sentence-based summary. Useful
for constructing your own summary string. Arrays must be of size
numSentences or they can be nil. Return value is the number of
sentences actually returned. Sentences are returned in text order
via outSentenceIndexOfSentences.

Parameters:

summary:
A reference to the summary object

numSentencesInSummary:
the number of sentences desired

outRankOrderOfSentences:
array for returning the rank of each sentence; most important
sentence is rank 1

outSentenceIndexOfSentences:
array for returning the index of each sentence; use
SKSummaryCopySentenceAtIndex to get sentence

outParagraphIndexOfSentences:
array for returning the index of the paragraph in which
sentence occured

Availability:
Mac OS X: in version 10.4 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFIndex SKSummaryGetSentenceSummaryInfo(SKSummaryRef, CFIndex, CFIndex*, CFIndex*, CFIndex*)

SKSummaryGetParagraphSummaryInfo

NativeLong SKSummaryGetParagraphSummaryInfo(SearchKitLibrary.__SKSummary summary,
                                            NativeLong numParagraphsInSummary,
                                            NativeLongByReference outRankOrderOfParagraphs,
                                            NativeLongByReference outParagraphIndexOfParagraphs)

SKSummaryGetParagraphSummaryInfo()

Summary:
Get detailed information about a paragraph-based summary. Useful
for constructing your own summary string. Arrays must be of size
numParagraphs or they can be nil. Return value is the number of
paragraphs actually returned. Paragraphs are returned in text
order via outParagraphIndexOfParagraphs.

Parameters:

summary:
A reference to the summary object

numParagraphsInSummary:
the number of sentences desired

outRankOrderOfParagraphs:
array for returning the rank of each paragraph; most important
paragraph is rank 1

outParagraphIndexOfParagraphs:
array for returning the index of each paragraph; use
SKSummaryCopyParagraphAtIndex to get paragraph

Availability:
Mac OS X: in version 10.4 and later in CoreServices.framework
CarbonLib: not available
Non-Carbon CFM: not available
Original signature : CFIndex SKSummaryGetParagraphSummaryInfo(SKSummaryRef, CFIndex, CFIndex*, CFIndex*)