| java.lang.Object
 com.flexive.core.search.PropertyEntry
| PropertyEntry | | public class PropertyEntry (Code) | |
A single entry of the property resolver, i.e. a selected property. A new entry is instantiated for every
column of a search query, it also stores context information like the column index in the SQL result set.
To create a new property entry type (e.g. a new virtual property), you have to:
- Register a new
PropertyEntry.Type that matches the property name
- Create a new subclass of
PropertyEntry that selects the columns and specifies
a method to read the value from the result set
- Extend the factory method
PropertyEntry.Type.createEntry
- Only if you need database-specific procedure calls: extend the
DataSelector implementation
author:
Gregor Schober (gregor.schober@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
author:
Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
version:
$Rev$ |
| Inner Class :public static enum Type | |
| multilanguage | | final protected boolean multilanguage(Code) | | |
| positionInResultSet | | protected int positionInResultSet(Code) | | |
| type | | final protected Type type(Code) | | |
| PropertyEntry | | public PropertyEntry(Property searchProperty, ContentStorage storage, boolean ignoreCase) throws FxSqlSearchException(Code) | | Create a new instance based on the given (search) property.
Parameters:
searchProperty - the search property
Parameters:
storage - the storage instance
Parameters:
ignoreCase - whether case should be ignored for this column
throws:
FxSqlSearchException - if the entry could not be created |
| getAssignment | | public FxPropertyAssignment getAssignment()(Code) | | Returns the (property) assignment. May be null if this entry does not represent
a structure element.
the property assignment |
| getFilterColumn | | public String getFilterColumn()(Code) | | Return the column name to be used for filtering (i.e. in the 'WHERE' clause of the query).
the column name to be used for filtering |
| getProperty | | public FxProperty getProperty()(Code) | | Returns the structure property, may be null if this entry does not actually represent
a structure element.
the structure property |
| getReadColumns | | public String[] getReadColumns()(Code) | | The column(s) to read the result from.
the column(s) to read the result from |
| getResultValue | | public Object getResultValue(ResultSet rs, FxLanguage language) throws FxSqlSearchException(Code) | | Return the result value of this property entry in a given result set.
Parameters:
rs - the SQL result set
Parameters:
language - the result language the value of this property (column) in the result set
throws:
FxSqlSearchException - if the database cannot read the value |
| getTableName | | public String getTableName()(Code) | | Return the database table name to be used for selecting/filtering, e.g.
FX_CONTENT_DATA.
the database table name to be used for selecting/filtering |
| getTableType | | public PropertyResolver.Table getTableType()(Code) | | Return the table type if it's a predefined table (like FX_CONTENT), null otherwise.
the table type if it's a predefined table (like FX_CONTENT), null otherwise. |
| getType | | public Type getType()(Code) | | Return the entry type.
the entry type. |
| isAssignment | | public boolean isAssignment()(Code) | | Returns true if this entry represents a structure (property) assignment.
true if this entry represents a structure (property) assignment. |
| setPositionInResultSet | | void setPositionInResultSet(int positionInResultSet)(Code) | | Set the entry's result set index while the query is being built.
Parameters:
positionInResultSet - the entry's result set index |
|
|