Package org.ametys.plugins.workspaces.wall

Class PinIndexingField

java.lang.Object

org.ametys.plugins.workspaces.wall.PinIndexingField

All Implemented Interfaces:

CustomIndexingField, IndexingField, PluginAware, Configurable

public class PinIndexingField
extends Object
implements CustomIndexingField, Configurable, PluginAware

CustomIndexingField for pinned wall content

Field Summary

Fields

Modifier and Type	Field	Description
private I18nizableText	_description
private I18nizableText	_label
private String	_pluginName

Constructor Summary

Constructors

Constructor	Description
PinIndexingField()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
I18nizableText	getDescription()	Get the field description.
I18nizableText	getLabel()	Get the field label.
String	getName()	Get the field's name
MetadataType	getType()	Get the type
Object[]	getValues(Content content)	Get a content's values to index.
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

Methods inherited from class java.lang.Object

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

Field Detail

_pluginName

private String _pluginName

_label

private I18nizableText _label

_description

private I18nizableText _description

Constructor Detail

PinIndexingField

public PinIndexingField()

Method Detail

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getName

public String getName()

Description copied from interface: IndexingField

Get the field's name

Specified by:

getName in interface IndexingField

Returns:

the field's name

getLabel

public I18nizableText getLabel()

Description copied from interface: IndexingField

Get the field label.

Specified by:

getLabel in interface IndexingField

Returns:

the field label.

getDescription

public I18nizableText getDescription()

Description copied from interface: IndexingField

Get the field description.

Specified by:

getDescription in interface IndexingField

Returns:

the field description.

getType

public MetadataType getType()

Description copied from interface: IndexingField

Get the type

Specified by:

getType in interface IndexingField

Returns:

the type

getValues

public Object[] getValues(Content content)

Description copied from interface: CustomIndexingField

Get a content's values to index.

Specified by:

getValues in interface CustomIndexingField

Parameters:

content - The content being indexed.

Returns:

the values to index.