|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IndexSource
IndexSource represent a collection of index data that will be indexed by SearchEngine. Each IndexSource will have a name which instructs SearchEngine which index that it needs to index the data to. It also contains the metadata information for the IndexSource that the SearchEngine would use
Method Summary | |
---|---|
void |
endIndexing(java.util.List<IndexRow> failed) This method must be called after the indexing is finished to allow data cleanup and handling of failed indexing data |
IndexSourceMetadata |
getConfiguration() Gets the metadata information for this index source. |
java.lang.Iterable<IndexRow> |
getDeleted() Gets the list of index data need to be deleted that this index source contains. |
QueryExpression |
getDeleteQuery() Gets the QueryExpression that SearchEngine could use to delete all the data that satisfy the QueryExpression. |
java.lang.Iterable<IndexRow> |
getModified() Gets the list of updated index data that this index source contains. |
java.lang.String |
getName() Gets the name of the IndexSource. |
java.lang.Iterable<IndexRow> |
getNew() Gets the list of new index data that this index source contains. |
void |
startIndexing() This method must to be called before actual indexing begins so that IndexSource would prepare the data needed |
Method Detail |
---|
java.lang.String getName()
java.lang.Iterable<IndexRow> getNew() throws IndexSourceException
IndexSourceException
- throws IndexSourceException if error met in getting the new index datajava.lang.Iterable<IndexRow> getModified() throws IndexSourceException
IndexSourceException
- throws IndexSourceException if error met in getting the updated index datajava.lang.Iterable<IndexRow> getDeleted() throws IndexSourceException
IndexSourceException
- throws IndexSourceException if error met in getting the index dataQueryExpression getDeleteQuery()
void startIndexing() throws IndexSourceException
IndexSourceException
- throws IndexSourceException if error metvoid endIndexing(java.util.List<IndexRow> failed)
failed
- a list of IndexRow which failed to indexIndexSourceMetadata getConfiguration()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.