Package lumis.doui.source.field.type

Class HtmlDataType.Data

java.lang.Object

lumis.doui.source.field.type.HtmlDataType.Data

All Implemented Interfaces:

CharSequence, IRenderable, ISearchable

Enclosing class:

HtmlDataType

public static class HtmlDataType.Data
extends Object
implements CharSequence, ISearchable, IRenderable

Data object for a html.

Since:

4.2.2

Version:

$Revision: 24271 $ $Date: 2020-12-09 22:17:18 -0300 (Wed, 09 Dec 2020) $

Constructor Summary

Constructors

Constructor	Description
Data(String html)

Method Summary

Modifier and Type	Method	Description
char	charAt(int index)
String	getDisplayString(IRenderer renderer)	Returns the string to be displayed for representing this instance, when a short display is required.
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.
int	length()
CharSequence	subSequence(int start, int end)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Constructor Detail

Data

public Data(String html)

Method Detail

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

public CharSequence subSequence(int start,
                                int end)

Specified by:

subSequence in interface CharSequence

length

public int length()

Specified by:

length in interface CharSequence

toString

public String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class 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

Returns:

the search content attachments.

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

Returns:

the search content fields. Never returns null. May return an empty collection if no field is to be used for indexing this object.

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

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

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