lumis.content.source.field

Class CategorizationSourceField

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

lumis.content.source.field.MetaDataSourceField

lumis.content.source.field.CategorizationSourceField

All Implemented Interfaces:

ISourceField, ITabularSourceField, ITableSourceField

public class CategorizationSourceField
extends MetaDataSourceField

Categorization source field used to make categorization information available in interface XML and for filter sources based on categories.

Since:

9.0.0

Version:

$Revision: 20808 $ $Date: 2017-11-30 19:13:55 +0000 (Thu, 30 Nov 2017) $

Nested Class Summary

Nested classes/interfaces inherited from class lumis.content.source.field.MetaDataSourceField

MetaDataSourceField.Type

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

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
CategorizationSourceField() Creates a new instance.

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 IConverter	createConverter() Factory method that creates a converter instance for this field.
List<QueryAssignment>	getQueryAssignments(QueryInsert queryInsert, IParameters parameters) Returns a list of query assignments to be used in the given query insert.
List<QueryAssignment>	getQueryAssignments(QueryUpdate queryUpdate, IParameters parameters) Returns a list of query assignments to be used in the given query update.
IQueryFilter	getQueryFilter(QueryBase queryBase, TableSourceFilter filter) Returns a query filter for this field.
void	init(Source source, Node fieldNode) Initializes this source field.

Methods inherited from class lumis.content.source.field.MetaDataSourceField

getDefaultInputControlDefinition, getType, isBigDataEnabled

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

createDataType, getQueryField, getTableMapping, isInsertable, isUpdatable

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

convertToQueryFieldValue, getAssignedValue, getDefaultInsertValue, getDisplayQueryField, getQueryField, 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, getConverter, getDataType, getDefaultControlDefinition, getDefaultValue, getDefaultViewControlDefinition, getDefinitionNode, getDocumentFieldBaseId, getId, getMaximumValue, getMinimumValue, getName, getValueClass, 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, 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

CategorizationSourceField

public CategorizationSourceField()
                          throws PortalException

Creates a new instance.

Throws:

PortalException

Since:

9.0.0

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 MetaDataSourceField

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.

getQueryAssignments

public 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

Overrides:

getQueryAssignments in class GenericTableSourceField

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

Overrides:

getQueryAssignments in class GenericTableSourceField

parameters - the parameters with the values to be used.

Returns:

the list of query assignments, never null.

Throws:

PortalException

getQueryFilter

public 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

Overrides:

getQueryFilter in class GenericTableSourceField

Parameters:

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

filter - the filter definition.

Returns:

the query filter.

Throws:

PortalException

convertRowToFieldData

public void convertRowToFieldData(ISourceData databaseRow,
                                  ISourceData sourceRow)
                           throws PortalException

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.

Throws:

PortalException

createConverter

protected IConverter createConverter()
                              throws PortalException

Description copied from class: BaseSourceField

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

Overrides:

createConverter in class BaseSourceField

Returns:

the converter instance created.

Throws:

PortalException