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.jdbc.mapping;
18:
19: import org.compass.core.Property;
20:
21: /**
22: * A general interface for a jdbc column mapping to a Compass
23: * <code>Property</code>. Holds differnt aspects of the mapped
24: * <code>Property</code> like the property name, the
25: * <code>Property.Index</code>, <code>Property.Store</code>,
26: * <code>Proeprty.TermVector</code> and the property boost level.
27: *
28: * @author kimchy
29: */
30: public interface ColumnToPropertyMapping extends ColumnMapping {
31:
32: /**
33: * Returns the <code>Resource</code> property name.
34: *
35: * @return the proeprty name.
36: */
37: String getPropertyName();
38:
39: /**
40: * Sets the <code>Resource</code> property name
41: *
42: */
43: void setPropertyName(String propertyName);
44:
45: /**
46: * Returns the property index option.
47: */
48: Property.Index getPropertyIndex();
49:
50: /**
51: * Returns the property store option.
52: */
53: Property.Store getPropertyStore();
54:
55: /**
56: * Returns the property termVector option.
57: */
58: Property.TermVector getPropertyTermVector();
59:
60: /**
61: * Returns the property boost level.
62: */
63: float getBoost();
64:
65: /**
66: * The analyzer that will be used to analyzer this property.
67: */
68: String getAnalyzer();
69:
70: /**
71: * Returns the converter lookup name that will be used to convert this property.
72: */
73: String getConverter();
74:
75: /**
76: * Should this property be excluded from the all property.
77: */
78: boolean isExcludeFromAll();
79: }
|