01: /*
02: * Copyright 2004-2006 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16:
17: package org.compass.gps.device.support.parallel;
18:
19: /**
20: * <p>Represents a groups of indexable conetnt associated with a name
21: * and provides the list of sub indexes it will be indexed into (for
22: * parallel indexing).
23: *
24: * <p>A typical implementation can be an ORM based device that has a
25: * Class as the Index Entity (with a simple select associated with it).
26: * In such a case, the index entity represents all the data that can
27: * be fetched basde on the Class type.
28: *
29: * @author kimchy
30: */
31: public interface IndexEntity {
32:
33: /**
34: * Returns the name of the index entity.
35: */
36: String getName();
37:
38: /**
39: * Returns a list of the sub indexes this indexable
40: * content the index entity represents is going to
41: * be indexed into. Used for parallel indexing.
42: */
43: String[] getSubIndexes();
44: }
|