|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SearchCollection
a Search Collection
Field Summary | |
---|---|
static short |
SEARCH_TYPE_EXPLICIT
Field SEARCH_TYPE_EXPLICIT |
static short |
SEARCH_TYPE_SIMPLE
Field SEARCH_TYPE_SIMPLE |
Method Summary | |
---|---|
SearchResulItem[] |
_search(SearchData data,
String criteria,
String language,
short type,
String categoryTree,
String[] category)
search the collection |
void |
create()
create a collection |
Object |
created()
return time when collection was created |
IndexResult |
delete()
delete the collection |
IndexResult |
deleteIndex(PageContext pc,
String key,
short type,
String queryName)
delete a Index from collection |
Object |
getCategoryInfo()
|
DateTime |
getCreated()
|
int |
getDocumentCount()
|
int |
getDocumentCount(String id)
|
String |
getLanguage()
|
DateTime |
getLastUpdate()
|
Log |
getLogger()
|
String |
getName()
|
Resource |
getPath()
|
SearchEngine |
getSearchEngine()
|
long |
getSize()
|
IndexResult |
index(PageContext pc,
String key,
short type,
String urlpath,
String title,
String body,
String language,
String[] extensions,
String query,
boolean recurse,
String categoryTree,
String[] categories,
String custom1,
String custom2,
String custom3,
String custom4)
updates a index of a collection |
IndexResult |
indexCustom(String id,
QueryColumn title,
QueryColumn keyColumn,
QueryColumn[] bodyColumns,
String language,
QueryColumn custom1,
QueryColumn custom2,
QueryColumn custom3,
QueryColumn custom4)
updates a collection with a custom |
IndexResult |
indexFile(String id,
String title,
Resource file,
String language)
updates a collection with a file |
IndexResult |
indexPath(String id,
String title,
Resource dir,
String[] extensions,
boolean recurse,
String language)
updates a collection with a path |
IndexResult |
indexURL(String id,
String title,
URL url,
String[] extensions,
boolean recurse,
String language)
updates a collection with a url |
void |
map(Resource path)
map a Collection |
void |
optimize()
optimize a Collection |
IndexResult |
purge()
purge a collection |
void |
repair()
repair a Collection |
int |
search(SearchData data,
Query qry,
String criteria,
String language,
short type,
int startrow,
int maxrow,
String categoryTree,
String[] category)
search the collection |
Field Detail |
---|
static final short SEARCH_TYPE_SIMPLE
SEARCH_TYPE_SIMPLE
static final short SEARCH_TYPE_EXPLICIT
SEARCH_TYPE_EXPLICIT
Method Detail |
---|
void create() throws SearchException
SearchException
void optimize() throws SearchException
SearchException
void map(Resource path) throws SearchException
path
-
SearchException
void repair() throws SearchException
SearchException
IndexResult index(PageContext pc, String key, short type, String urlpath, String title, String body, String language, String[] extensions, String query, boolean recurse, String categoryTree, String[] categories, String custom1, String custom2, String custom3, String custom4) throws PageException, MalformedURLException, SearchException
pc
- key
- type
- urlpath
- title
- body
- language
- extensions
- query
- recurse
- categoryTree
- categories
- custom1
- custom2
- custom3
- custom4
-
PageException
MalformedURLException
SearchException
IndexResult indexFile(String id, String title, Resource file, String language) throws SearchException
id
- title
- file
- language
-
SearchException
IndexResult indexPath(String id, String title, Resource dir, String[] extensions, boolean recurse, String language) throws SearchException
id
- title
- dir
- recurse
- extensions
- language
-
SearchException
IndexResult indexURL(String id, String title, URL url, String[] extensions, boolean recurse, String language) throws SearchException
id
- title
- recurse
- extensions
- url
- language
-
SearchException
IndexResult indexCustom(String id, QueryColumn title, QueryColumn keyColumn, QueryColumn[] bodyColumns, String language, QueryColumn custom1, QueryColumn custom2, QueryColumn custom3, QueryColumn custom4) throws SearchException
id
- title
- Title for the IndexkeyColumn
- Key ColumnbodyColumns
- Body Column Arraylanguage
- Language for indexcustom1
- custom2
- custom3
- custom4
-
SearchException
String getLanguage()
IndexResult purge() throws SearchException
SearchException
IndexResult delete() throws SearchException
SearchException
IndexResult deleteIndex(PageContext pc, String key, short type, String queryName) throws SearchException
pc
- key
- type
- queryName
-
SearchException
Resource getPath()
DateTime getCreated()
DateTime getLastUpdate()
String getName()
Log getLogger()
SearchEngine getSearchEngine()
Object created()
int search(SearchData data, Query qry, String criteria, String language, short type, int startrow, int maxrow, String categoryTree, String[] category) throws SearchException, PageException
data
- qry
- Query to append resutscriteria
- language
- type
- SEARCH_TYPE_EXPLICIT or SEARCH_TYPE_SIMPLEstartrow
- maxrow
- categoryTree
- category
-
SearchException
PageException
SearchResulItem[] _search(SearchData data, String criteria, String language, short type, String categoryTree, String[] category) throws SearchException
data
- criteria
- language
- type
- SEARCH_TYPE_EXPLICIT or SEARCH_TYPE_SIMPLEcategoryTree
- category
-
SearchException
long getSize()
int getDocumentCount()
int getDocumentCount(String id)
Object getCategoryInfo()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |