lumis.service.image.field
Class ImageDataType.Data

java.lang.Object
  lumis.doui.source.field.type.FileDataType.Data
      lumis.service.image.field.ImageDataType.Data

All Implemented Interfaces:

IRenderable, ISearchable

Enclosing class:

ImageDataType

public static class ImageDataType.Data
extends FileDataType.Data

Data object for a field with data type image.

Since:

4.0.4

Constructor Summary

ImageDataType.Data()

Method Summary

String	getCredits()
String	getDisplayString(IRenderer renderer) Returns the string to be displayed for representing this instance, when a short display is required.
String	getImageId()
String	getLegend()
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()
void	setCredits(String credits)
void	setImageId(String imageId)
void	setLegend(String legend)
void	setTitle(String title)

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

getContentType, getFileId, getFileSize, getFullPath, getIcon, getName, setContentType, setFileId, setFileSize, setFullPath, setIcon, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageDataType.Data

public ImageDataType.Data()

Method Detail

getImageId

public String getImageId()

setImageId

public void setImageId(String imageId)

getLegend

public String getLegend()

setLegend

public void setLegend(String legend)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getCredits

public String getCredits()

setCredits

public void setCredits(String credits)

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

Overrides:

getRenderData in class FileDataType.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 interface IRenderable

Overrides:

getDisplayString in class FileDataType.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 interface ISearchable

Overrides:

getSearchContentFields in class FileDataType.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 interface ISearchable

Overrides:

getSearchContentAttachments in class FileDataType.Data

Returns:

the search content attachments.