lumis.doui.table.field

Class ExperimentalGenericTableSourceField

java.lang.Object

lumis.doui.source.field.BaseSourceField

lumis.doui.source.field.BaseTabularSourceField

lumis.doui.table.field.BaseTableSourceField

lumis.doui.table.field.GenericTableSourceField

lumis.doui.table.field.ExperimentalGenericTableSourceField

All Implemented Interfaces:

ISourceField, ITabularSourceField, ITableSourceField

public class ExperimentalGenericTableSourceField
extends GenericTableSourceField

This class is responsible to define a single column field in a specified source.

The attribute tableRelationId is used to references a mapped table and the attribute, queryFieldId can be used to references a specified mapped field, expression can be used to replace the attribute queryFieldId and the attribute groupBy is used if the queryFieldId have to be grouped.

Since:

7.0.0

Version:

$Revision: 15056 $ $Date: 2012-11-29 20:51:41 +0000 (Thu, 29 Nov 2012) $

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
ExperimentalGenericTableSourceField()

Method Summary

Modifier and Type	Method and Description
protected QueryField	getQueryField(QueryBase queryBase) Returns the main query field for this source field.
TableSourceFieldMapping	getTableMapping(QueryBase queryBase) Returns the table mapping for this field.
void	init(Source source, Node fieldNode) Initializes this source field.
boolean	isReadOnly() Returns true if this field is read-only and should not be rendered editable.

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

convertRowToFieldData, convertToQueryFieldValue, getAssignedValue, getDefaultInsertValue, getDisplayQueryField, getQueryAssignments, getQueryAssignments, getQueryField, getQueryFilter, getQuerySortOrders

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, 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, isRequired, isRequiredWhenVisible, isSearchable, postAdd, postDelete, postUpdate, preAdd, preDelete, preUpdate

Constructor Detail

ExperimentalGenericTableSourceField

public ExperimentalGenericTableSourceField()

Method Detail

init

public void init(Source source,
                 Node fieldNode)
          throws PortalException

Description copied from interface: ISourceField

Initializes this source field. This method is called by the source after the field is created and before it is used. The implementation of this method must initialize all of this instance's attributes.

Specified by:

init in interface ISourceField

Overrides:

init in class GenericTableSourceField

Parameters:

source - the source this field will belong to.

fieldNode - the xml node that contains this field's definition.

Throws:

PortalException - if this field could not be initialized.

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

isReadOnly

public boolean isReadOnly()

Description copied from interface: ISourceField

Returns true if this field is read-only and should not be rendered editable.

Specified by:

isReadOnly in interface ISourceField

Overrides:

isReadOnly in class BaseSourceField

Returns:

true if this field is read-only, false otherwise.

getQueryField

protected QueryField getQueryField(QueryBase queryBase)
                            throws PortalException

Description copied from class: GenericTableSourceField

Returns the main query field for this source field.

Overrides:

getQueryField in class GenericTableSourceField

Parameters:

queryBase - the query base where the query field will be used.

Returns:

the query field.

Throws:

PortalException