Package lumis.doui.source.field.type

Interface ISourceFieldDataType

All Superinterfaces:

IDouiDataType

All Known Implementing Classes:

AbstractSourceFieldDataType, AnyDataType, BooleanDataType, CategorizationDataType, ChannelDataType, ContentParentContentDataType, DateDataType, DateTimeDataType, DocumentDataType, DoubleDataType, EmailDataType, FileDataType, FilesDataType, GuidDataType, HtmlDataType, ImageDataType, IntegerDataType, LocaleMetaDataDataType, LongDataType, MediaDataType, PageDataType, PageOrPageTemplateDataType, PageTemplateDataType, ParentContentDataType, PasswordDataType, PrincipalDataType, ResourcesDataType, StringDataType, TagDataType, TextDataType, TimeDataType, WorkflowAssignedToDataType, WorkflowStateDataType

@StableMinor(version="14.0",
             sinceVersion="4.0")
public interface ISourceFieldDataType
extends IDouiDataType

A data type of a ISourceField

Since:

4.0.4

Version:

$Revision: 24476 $ $Date: 2021-04-28 11:28:23 -0300 (Wed, 28 Apr 2021) $

Method Summary

Modifier and Type	Method	Description
Map<String,? extends Serializable>	getDocumentFieldValues(Object value)	Returns the document field values to be stored in big data for a given value.
Map<String,? extends IDocumentTypeFieldBuilder<?>>	getDocumentTypeFieldTemplates()	Returns the document type field templates to be used as a base by source fields to create their document type fields.
String	getQueryDataType()	Returns a QueryFieldTypes constant for a query data type the value of this source field data type is best suited to be kept in.
void	init(ISourceContext sourceContext)	Initializes this data type to be used in the given source context.
default void	postAdd(ISourceField field, SourcePostAddDataEvent event)	Method called by default for each source field after data is added.
default void	postDelete(ISourceField field, SourcePostDeleteDataEvent event)	Method called by default for each source field after data is deleted.
default void	postUpdate(ISourceField field, SourcePostUpdateDataEvent event)	Method called by default for each source field after data is updated.
default void	preAdd(ISourceField field, SourcePreAddDataEvent event)	Method called by default for each source field before data is added.
default void	preDelete(ISourceField field, SourcePreDeleteDataEvent event)	Method called by default for each source field before data is deleted.
default void	preUpdate(ISourceField field, SourcePreUpdateDataEvent event)	Method called by default for each source field before data is updated.

Methods inherited from interface lumis.doui.datatype.IDouiDataType

getConverter, getDefaultFilterControlType, getDefaultInputControlType, getDefaultViewControlType, getDefinitionLocale, getDefinitionPattern, getId, getValueClass, isComplexDataType

Method Detail

init

void init(ISourceContext sourceContext)
   throws PortalException

Initializes this data type to be used in the given source context.

Parameters:

sourceContext - the source context where this data type will be used in.

Throws:

PortalException

Since:

4.0.4

getQueryDataType

String getQueryDataType()

Returns a QueryFieldTypes constant for a query data type the value of this source field data type is best suited to be kept in.

Returns:

a QueryFieldTypes constant.

Since:

4.0.4

getDocumentTypeFieldTemplates

Map<String,? extends IDocumentTypeFieldBuilder<?>> getDocumentTypeFieldTemplates()

Returns the document type field templates to be used as a base by source fields to create their document type fields.

The returned value is a map where the key is an identifier suffix to use on the document field identifier. This suffix will be appended to the source field's base identifier in the document. The key may be null to indicate that the source field's base identifier is to be used for the document field. The key must not be an empty string.

The value of the map is a IDocumentTypeFieldBuilder to be used as a base to the respective document type field. The builder's id will be set by the source field and does not need to be specified. The IDocumentTypeFieldBuilder.setIncludeInGlobalSearch(boolean) is to be set to true if the document field may be included in global search. If it is set to true and the source field is searchable, then the final document type field generated will have this property set to true. Otherwise it will be false.

Returns:

a map where the key is a relative document field identifier and the value is a document type field builder to be used as a base to the respective document type field.

Since:

8.1.0

See Also:

getDocumentFieldValues(Object)

getDocumentFieldValues

Map<String,? extends Serializable> getDocumentFieldValues(Object value)

Returns the document field values to be stored in big data for a given value.

Parameters:

value - a value, of type IDouiDataType.getValueClass() or of a type that IDouiDataType.getConverter() is able to convert to IDouiDataType.getValueClass().

Returns:

a map where the key is a suffix for the document field identifier, and the value is the value to use as the value of the respective document field. The key is the same used to define document type fields in getDocumentTypeFieldTemplates().

Since:

8.1.0

See Also:

getDocumentTypeFieldTemplates()

preAdd

default void preAdd(ISourceField field,
                    SourcePreAddDataEvent event)
             throws PortalException

Method called by default for each source field before data is added.

Parameters:

field - the field that is triggering this call.

event - the event that contains information about the add operation.

Throws:

PortalException

Since:

10.4.0

See Also:

ISourceField#preAdd(ISourcePreAddDataEvent)

postAdd

default void postAdd(ISourceField field,
                     SourcePostAddDataEvent event)
              throws PortalException

Method called by default for each source field after data is added.

Parameters:

field - the field that is triggering this call.

event - the event that contains information about the add operation.

Throws:

PortalException

Since:

10.4.0

See Also:

ISourceField#postAdd(ISourcePostAddDataEvent)

preUpdate

default void preUpdate(ISourceField field,
                       SourcePreUpdateDataEvent event)
                throws PortalException

Method called by default for each source field before data is updated.

Parameters:

field - the field that is triggering this call.

event - the event that contains information about the update operation.

Throws:

PortalException

Since:

10.4.0

See Also:

ISourceField#preUpdate(ISourcePreUpdateDataEvent)

postUpdate

default void postUpdate(ISourceField field,
                        SourcePostUpdateDataEvent event)
                 throws PortalException

Method called by default for each source field after data is updated.

Parameters:

field - the field that is triggering this call.

event - the event that contains information about the update operation.

Throws:

PortalException

Since:

10.4.0

See Also:

ISourceField#postUpdate(ISourcePostUpdateDataEvent)

preDelete

default void preDelete(ISourceField field,
                       SourcePreDeleteDataEvent event)
                throws PortalException

Method called by default for each source field before data is deleted.

Parameters:

field - the field that is triggering this call.

event - the event that contains information about the delete operation.

Throws:

PortalException

Since:

10.4.0

See Also:

ISourceField#preDelete(ISourcePreDeleteDataEvent)

postDelete

default void postDelete(ISourceField field,
                        SourcePostDeleteDataEvent event)
                 throws PortalException

Method called by default for each source field after data is deleted.

Parameters:

field - the field that is triggering this call.

event - the event that contains information about the delete operation.

Throws:

PortalException

Since:

10.4.0

See Also:

ISourceField#postDelete(ISourcePostDeleteDataEvent)