lumis.service.document.field

Class DocumentSourceField

java.lang.Object

lumis.doui.source.field.BaseSourceField

lumis.doui.source.field.BaseTabularSourceField

lumis.doui.table.field.BaseTableSourceField

lumis.doui.table.field.GenericTableSourceField

lumis.service.document.field.DocumentSourceField

All Implemented Interfaces:

ISourceField, ITabularSourceField, ITableSourceField

public class DocumentSourceField
extends GenericTableSourceField

A document source field.

Since:

4.0.4

Version:

$Revision: 16380 $ $Date: 2014-08-01 19:52:27 +0000 (Fri, 01 Aug 2014) $

Field Summary

Fields inherited from class lumis.doui.table.field.GenericTableSourceField

localizeResourceQueryField, lookupQueryField

Fields inherited from class lumis.doui.source.field.BaseTabularSourceField

columnName, position, primaryKey, primaryName, sortable

Fields inherited from class lumis.doui.source.field.BaseSourceField

converter, dataType, defaultValue, definitionNode, display, doOptionLookup, externalData, getData, id, introduction, keywords, localize, maximumValue, minimumValue, name, parentId, pattern, readOnly, required, requiredWhenVisible, searchable, source

Constructor Summary

Constructors

Constructor and Description
DocumentSourceField()

Method Summary

Modifier and Type	Method and Description
void	convertRowToFieldData(ISourceData databaseRow, ISourceData sourceRow) Converts a row read from the data provider to this source field type.
protected Object	convertToQueryFieldValue(QueryField queryField, Object value) Convert the value to the value to be assigned to the given query field.
TableSourceFieldMapping	getTableMapping(QueryBase queryBase) Returns the table mapping for this field.

Methods inherited from class lumis.doui.table.field.GenericTableSourceField

getAssignedValue, getDefaultInsertValue, getDisplayQueryField, getQueryAssignments, getQueryAssignments, getQueryField, getQueryField, getQueryFilter, getQuerySortOrders, init

Methods inherited from class lumis.doui.table.field.BaseTableSourceField

isLookupEnabled

Methods inherited from class lumis.doui.source.field.BaseTabularSourceField

getColumnName, isInsertable, isPosition, isPrimaryKey, isPrimaryName, isSortable, isUpdatable

Methods inherited from class lumis.doui.source.field.BaseSourceField

addDocumentFields, addDocumentTypeFields, convertToFieldValueClass, createConverter, createDataType, getConverter, getDataType, getDefaultControlDefinition, getDefaultInputControlDefinition, getDefaultValue, getDefaultViewControlDefinition, getDefinitionNode, getDocumentFieldBaseId, getId, getMaximumValue, getMinimumValue, getName, getValueClass, isBigDataEnabled, isDisplay, isExternalData, isGetData, isIntroduction, isIntroductionImage, isKeywords, isLocalize, isParentId, isPublishStartDate, isReadOnly, isRequired, isRequiredWhenVisible, isSearchable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface lumis.doui.source.field.ITabularSourceField

isPosition, isPrimaryKey, isSortable

Methods inherited from interface lumis.doui.source.field.ISourceField

addDocumentFields, addDocumentTypeFields, getConverter, getDataType, getDefaultControlDefinition, getDefaultInputControlDefinition, getDefaultValue, getDefaultViewControlDefinition, getDefinitionNode, getId, getMaximumValue, getMinimumValue, getName, getValueClass, isDisplay, isExternalData, isGetData, isIntroduction, isIntroductionImage, isKeywords, isParentId, isPrimaryName, isPublishStartDate, isReadOnly, isRequired, isRequiredWhenVisible, isSearchable, postAdd, postDelete, postUpdate, preAdd, preDelete, preUpdate

Constructor Detail

DocumentSourceField

public DocumentSourceField()

Method Detail

getTableMapping

public TableSourceFieldMapping getTableMapping(QueryBase queryBase)
                                        throws PortalException

Description copied from interface: ITableSourceField

Returns the table mapping for this field. This specifies how the field data is accessed.

Specified by:

getTableMapping in interface ITableSourceField

Overrides:

getTableMapping in class GenericTableSourceField

Parameters:

queryBase - the query the mapping will be used.

Returns:

the field table mapping.

Throws:

PortalException

convertRowToFieldData

public void convertRowToFieldData(ISourceData databaseRow,
                                  ISourceData sourceRow)

Description copied from class: BaseTabularSourceField

Converts a row read from the data provider to this source field type.

This base implementation just copies the value in the database row relative to this field's id to the source row using the same id, converting it using BaseSourceField.convertToFieldValueClass(Object, java.util.Locale, String).

Specified by:

convertRowToFieldData in interface ITabularSourceField

Overrides:

convertRowToFieldData in class GenericTableSourceField

Parameters:

databaseRow - a row containing the original data.

sourceRow - the row to be populated with this field's data.

convertToQueryFieldValue

protected Object convertToQueryFieldValue(QueryField queryField,
                                          Object value)

Description copied from class: GenericTableSourceField

Convert the value to the value to be assigned to the given query field.

Overrides:

convertToQueryFieldValue in class GenericTableSourceField

Parameters:

queryField - the query field.

value - the original value.

Returns:

the value converted.