Package lumis.service.document.field
Class DocumentDataType.Data
- java.lang.Object
-
- lumis.doui.source.field.type.FileDataType.Data
-
- lumis.service.document.field.DocumentDataType.Data
-
- All Implemented Interfaces:
IRenderable
,ISearchable
- Enclosing class:
- DocumentDataType
public static class DocumentDataType.Data extends FileDataType.Data
Data object for a field with data type document.- Since:
- 4.0.4
-
-
Constructor Summary
Constructors Constructor Description Data()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDescription()
The document description.String
getDisplayString(IRenderer renderer)
Returns the string to be displayed for representing this instance, when a short display is required.String
getDocumentId()
protected Map<String,Object>
getJSONData()
Returns the render data in JSON format.String
getRenderData(IRenderer renderer)
Returns the data of this object in a standard xml format.Collection<SearchContentAttachment>
getSearchContentAttachments()
Returns the search content attachments to be used for indexing this object.List<SearchContentField>
getSearchContentFields()
Returns the search content fields to be used for indexing this object.String
getTitle()
protected String
getXMLFragmentData(IRenderer renderer)
Returns the render data XML fragment.void
setDescription(String description)
The document description.void
setDocumentId(String documentId)
void
setTitle(String title)
-
Methods inherited from class lumis.doui.source.field.type.FileDataType.Data
getContentType, getFileId, getFileSize, getFullPath, getIcon, getMetadata, getName, setContentType, setFileId, setFileSize, setFullPath, setIcon, setMetadata, setName
-
-
-
-
Method Detail
-
getDocumentId
public String getDocumentId()
-
setDocumentId
public void setDocumentId(String documentId)
-
getTitle
public String getTitle()
-
setTitle
public void setTitle(String title)
-
getDescription
public String getDescription()
The document description.- Returns:
- description.
- Since:
- 4.2.2
-
setDescription
public void setDescription(String description)
The document description.- Parameters:
description
- .- Since:
- 4.2.2
-
getRenderData
public String getRenderData(IRenderer renderer) throws PortalException
Description copied from interface:IRenderable
Returns the data of this object in a standard xml format.- Specified by:
getRenderData
in interfaceIRenderable
- Overrides:
getRenderData
in classFileDataType.Data
- Parameters:
renderer
- the renderer object that will use the returned render data.- Returns:
- the xml data for this object.
- Throws:
PortalException
-
getDisplayString
public String getDisplayString(IRenderer renderer) throws PortalException
Description copied from interface:IRenderable
Returns the string to be displayed for representing this instance, when a short display is required.- Specified by:
getDisplayString
in interfaceIRenderable
- Overrides:
getDisplayString
in classFileDataType.Data
- Parameters:
renderer
- the renderer object that will use the returned render data.- Returns:
- the string to be used to friendly display this instance.
- Throws:
PortalException
-
getSearchContentFields
public List<SearchContentField> getSearchContentFields()
Description copied from interface:ISearchable
Returns the search content fields to be used for indexing this object.Note that the actual search content fields used are decided by the
ISourceSearchContentFiller
implementation used in the source. It may or may not use the fields returned by this method. This method provides only the default recommended search fields for this data.- Specified by:
getSearchContentFields
in interfaceISearchable
- Overrides:
getSearchContentFields
in classFileDataType.Data
- Returns:
- the search content fields. Never returns
null
. May return an empty collection if no field is to be used for indexing this object.
-
getSearchContentAttachments
public Collection<SearchContentAttachment> getSearchContentAttachments()
Description copied from interface:ISearchable
Returns the search content attachments to be used for indexing this object.Must never return
null
. May return an empty collection if no attachment is to be used for indexing this object.- Specified by:
getSearchContentAttachments
in interfaceISearchable
- Overrides:
getSearchContentAttachments
in classFileDataType.Data
- Returns:
- the search content attachments.
-
getXMLFragmentData
protected String getXMLFragmentData(IRenderer renderer) throws PortalException
Returns the render data XML fragment.- Overrides:
getXMLFragmentData
in classFileDataType.Data
- Parameters:
renderer
- the DOUI renderer of this data, ornull
if outside DOUI context.- Returns:
- the XML fragment.
- Throws:
PortalException
- Since:
- 7.0.1
-
getJSONData
protected Map<String,Object> getJSONData() throws PortalException
Returns the render data in JSON format.- Overrides:
getJSONData
in classFileDataType.Data
- Returns:
- the Map
with render data information about the file. - Throws:
PortalException
- Since:
- 6.1.0
-
-