lumis.doui.table.field

Class BaseTableSourceField

java.lang.Object

lumis.doui.source.field.BaseSourceField

lumis.doui.source.field.BaseTabularSourceField

lumis.doui.table.field.BaseTableSourceField

All Implemented Interfaces:

ISourceField, ITabularSourceField, ITableSourceField

Direct Known Subclasses:

GenericTableSourceField, GroupConfigurationButtonField, GroupTypeConfigurationButtonField

@StableMinor(version="12.3",
             sinceVersion="4.0")
public abstract class BaseTableSourceField
extends BaseTabularSourceField
implements ITableSourceField

Base implementation for the ITableSourceField interface.

Since:

4.0.4

Version:

$Revision: 23747 $ $Date: 2020-04-07 23:16:33 +0000 (Tue, 07 Apr 2020) $

Field Summary

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

Method Summary

Modifier and Type	Method and Description
abstract Object	getAssignedValue(QueryBase queryBase) Returns the value assigned as this field's value in the given query.
abstract List<QueryAssignment>	getQueryAssignments(QueryInsert queryInsert, IParameters parameters) Returns a list of query assignments to be used in the given query insert.
abstract List<QueryAssignment>	getQueryAssignments(QueryUpdate queryUpdate, IParameters parameters) Returns a list of query assignments to be used in the given query update.
abstract IQueryFilter	getQueryFilter(QueryBase queryBase, TableSourceFilter filter) Returns a query filter for this field.
abstract List<QuerySortOrder>	getQuerySortOrders(QueryBase queryBase, String direction) Returns a list of sort orders to be applied when it is to be ordered by this field.
abstract TableSourceFieldMapping	getTableMapping(QueryBase queryBase) Returns the table mapping for this field.
protected boolean	isLookupEnabled() Returns if the lookup is enabled for this field.

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

convertRowToFieldData, getColumnName, init, 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.table.field.ITableSourceField

getDisplayQueryField

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

convertRowToFieldData, 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, init, isDisplay, isExternalData, isGetData, isIntroduction, isIntroductionImage, isKeywords, isParentId, isPrimaryName, isPublishStartDate, isReadOnly, isRequired, isRequiredWhenVisible, isSearchable, postAdd, postDelete, postUpdate, preAdd, preDelete, preUpdate

Constructor Detail

BaseTableSourceField

public BaseTableSourceField()

Method Detail

getTableMapping

public abstract 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

Parameters:

queryBase - the query the mapping will be used.

Returns:

the field table mapping.

Throws:

PortalException

getQueryFilter

public abstract IQueryFilter getQueryFilter(QueryBase queryBase,
                                            TableSourceFilter filter)
                                     throws PortalException

Description copied from interface: ITableSourceField

Returns a query filter for this field.

Specified by:

getQueryFilter in interface ITableSourceField

Parameters:

queryBase - the query where the filter will be applied to.

filter - the filter definition.

Returns:

the query filter.

Throws:

PortalException

getQuerySortOrders

public abstract List<QuerySortOrder> getQuerySortOrders(QueryBase queryBase,
                                                        String direction)
                                                 throws PortalException

Description copied from interface: ITableSourceField

Returns a list of sort orders to be applied when it is to be ordered by this field.

Specified by:

getQuerySortOrders in interface ITableSourceField

Parameters:

queryBase - the query where the sort orders will be applied to.

direction - the direction this field is to be sorted.

Returns:

a list of sort orders, never null. May be an empty list if this field is not sortable.

Throws:

PortalException

getQueryAssignments

public abstract List<QueryAssignment> getQueryAssignments(QueryInsert queryInsert,
                                                          IParameters parameters)
                                                   throws PortalException

Description copied from interface: ITableSourceField

Returns a list of query assignments to be used in the given query insert.

Specified by:

getQueryAssignments in interface ITableSourceField

Parameters:

queryInsert - the query insert.

parameters - the parameters with the values to be used.

Returns:

the list of query assignments, never null.

Throws:

PortalException

getQueryAssignments

public abstract List<QueryAssignment> getQueryAssignments(QueryUpdate queryUpdate,
                                                          IParameters parameters)
                                                   throws PortalException

Description copied from interface: ITableSourceField

Returns a list of query assignments to be used in the given query update.

Specified by:

getQueryAssignments in interface ITableSourceField

parameters - the parameters with the values to be used.

Returns:

the list of query assignments, never null.

Throws:

PortalException

getAssignedValue

public abstract Object getAssignedValue(QueryBase queryBase)
                                 throws PortalException

Description copied from interface: ITableSourceField

Returns the value assigned as this field's value in the given query.

Specified by:

getAssignedValue in interface ITableSourceField

Parameters:

queryBase - the query.

Returns:

the value assigned as this field's value.

Throws:

PortalException

isLookupEnabled

protected boolean isLookupEnabled()

Returns if the lookup is enabled for this field. Verifies the doLookup attribute in the field definition node.

Returns:

true if lookup is enabled for this field, false otherwise.

Since:

4.0.4