Package lumis.service.document.field

Class DocumentDataType

java.lang.Object

lumis.doui.datatype.AbstractDouiDataType

lumis.doui.source.field.type.AbstractSourceFieldDataType

lumis.doui.source.field.type.FileDataType

lumis.service.document.field.DocumentDataType

All Implemented Interfaces:

IDouiDataType, ISourceFieldDataType

public class DocumentDataType
extends FileDataType

A document data type. Its value is a reference to a document content.

Since:

4.0.4

Version:

$Revision: 20857 $ $Date: 2017-12-27 13:27:30 -0200 (Wed, 27 Dec 2017) $

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentDataType.Data	Data object for a field with data type document.

Nested classes/interfaces inherited from class lumis.doui.source.field.type.FileDataType

FileDataType.FileDataConverter, FileDataType.FileDataParser

Constructor Summary

Constructors

Constructor	Description
DocumentDataType()

Method Summary

Modifier and Type	Method	Description
protected IConverter	createConverter()	Creates the converter instance that will be used by this data type.
protected void	deleteRelatedFile(ISourceField field, SourcePreDeleteDataEvent event)	Deletes related files from persistence.
String	getDefaultInputControlType()	Returns the default input control type for this data type.
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	getId()	Returns the id for this data type.
Class<DocumentDataType.Data>	getValueClass()	Returns the value class for data of this type.

Methods inherited from class lumis.doui.source.field.type.FileDataType

getQueryDataType, preDelete

Methods inherited from class lumis.doui.source.field.type.AbstractSourceFieldDataType

init

Methods inherited from class lumis.doui.datatype.AbstractDouiDataType

equals, getConverter, getDefaultFilterControlType, getDefaultViewControlType, getDefinitionLocale, getDefinitionPattern, hashCode, isComplexDataType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface lumis.doui.datatype.IDouiDataType

getConverter, getDefaultFilterControlType, getDefaultViewControlType, getDefinitionLocale, getDefinitionPattern, isComplexDataType

Methods inherited from interface lumis.doui.source.field.type.ISourceFieldDataType

postAdd, postDelete, postUpdate, preAdd, preUpdate

Constructor Detail

DocumentDataType

public DocumentDataType()

Method Detail

createConverter

protected IConverter createConverter()

Description copied from class: AbstractDouiDataType

Creates the converter instance that will be used by this data type.

Overrides:

createConverter in class FileDataType

Returns:

the converter instance.

getId

public String getId()

Description copied from interface: IDouiDataType

Returns the id for this data type.

Specified by:

getId in interface IDouiDataType

Overrides:

getId in class FileDataType

Returns:

the id for this data type.

getValueClass

public Class<DocumentDataType.Data> getValueClass()

Description copied from interface: IDouiDataType

Returns the value class for data of this type.

Specified by:

getValueClass in interface IDouiDataType

Overrides:

getValueClass in class FileDataType

Returns:

the value class for data of this type.

getDefaultInputControlType

public String getDefaultInputControlType()

Description copied from interface: IDouiDataType

Returns the default input control type for this data type.

Specified by:

getDefaultInputControlType in interface IDouiDataType

Overrides:

getDefaultInputControlType in class FileDataType

Returns:

the default input control type for this data type, or null if this data type has no default input control type.

getDocumentTypeFieldTemplates

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

Description copied from interface: ISourceFieldDataType

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.

Specified by:

getDocumentTypeFieldTemplates in interface ISourceFieldDataType

Overrides:

getDocumentTypeFieldTemplates in class FileDataType

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.

See Also:

ISourceFieldDataType.getDocumentFieldValues(Object)

getDocumentFieldValues

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

Description copied from interface: ISourceFieldDataType

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

Specified by:

getDocumentFieldValues in interface ISourceFieldDataType

Overrides:

getDocumentFieldValues in class FileDataType

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 ISourceFieldDataType.getDocumentTypeFieldTemplates().

See Also:

ISourceFieldDataType.getDocumentTypeFieldTemplates()

deleteRelatedFile

protected void deleteRelatedFile(ISourceField field,
                                 SourcePreDeleteDataEvent event)
                          throws PortalException

Description copied from class: FileDataType

Deletes related files from persistence. Called by FileDataType.preDelete(ISourceField, SourcePreDeleteDataEvent).

Overrides:

deleteRelatedFile in class FileDataType

Parameters:

field - the field that triggered the call.

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

Throws:

PortalException