Package lumis.doui.table.field

Class SingleColumnTableSourceField

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.SingleColumnTableSourceField

All Implemented Interfaces:

ISourceField, ITabularSourceField, ITableSourceField

Direct Known Subclasses:

MetaDataSourceField

public class SingleColumnTableSourceField
extends GenericTableSourceField

A generic single column table source field. The column may be in the main table or in a foreign table with the given tableRelationId.

Since:

4.0.4

Version:

$Revision$ $Date$

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	Description
SingleColumnTableSourceField(java.lang.String tableRelationId, java.lang.String columnName, java.lang.String dataTypeId)
SingleColumnTableSourceField(java.lang.String tableRelationId, java.lang.String columnName, ISourceFieldDataType dataType)

Method Summary

Modifier and Type	Method	Description
protected ISourceFieldDataType	createDataType()	Factory method that creates a data type instance for this field.
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, org.w3c.dom.Node fieldNode)	Initializes this source field.
protected boolean	isInsertable()	Indicates if the value this field represents may be inserted.
protected boolean	isUpdatable()	Indicates if the value this field represents is updatable.

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, isPosition, isPrimaryKey, isPrimaryName, isSortable

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

addDocumentFields, addDocumentTypeFields, convertToFieldValueClass, createConverter, 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.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, prepareValueForDataCloning, preUpdate

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

isPosition, isPrimaryKey, isSortable

Constructor Detail

SingleColumnTableSourceField

public SingleColumnTableSourceField(java.lang.String tableRelationId,
                                    java.lang.String columnName,
                                    java.lang.String dataTypeId)
                             throws PortalException

Throws:

PortalException

SingleColumnTableSourceField

public SingleColumnTableSourceField(java.lang.String tableRelationId,
                                    java.lang.String columnName,
                                    ISourceFieldDataType dataType)

Method Detail

init

public void init(Source source,
                 org.w3c.dom.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.

createDataType

protected ISourceFieldDataType createDataType()
                                       throws PortalException

Description copied from class: BaseSourceField

Factory method that creates a data type instance for this field. This method is called during BaseSourceField.init(Source, Node).

Overrides:

createDataType in class BaseSourceField

Returns:

the data type instance created.

Throws:

PortalException

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

isInsertable

protected boolean isInsertable()

Description copied from class: BaseTabularSourceField

Indicates if the value this field represents may be inserted.

Overrides:

isInsertable in class BaseTabularSourceField

Returns:

true if this field's value may be inserted, false otherwise.

isUpdatable

protected boolean isUpdatable()

Description copied from class: BaseTabularSourceField

Indicates if the value this field represents is updatable.

Overrides:

isUpdatable in class BaseTabularSourceField

Returns:

true if this field's value is updatable, 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