Package org.silverpeas.core.index.indexing.model

Class FieldDescription

java.lang.Object

org.silverpeas.core.index.indexing.model.FieldDescription

All Implemented Interfaces:

Serializable

public class FieldDescription
extends Object
implements Serializable

A FieldDescription pack all the needed information to parse and index a generic field (xml field, iptc field) We need :

• the name of the field
• its content
• its language
• to know if its value must be stored in the index (then value could be exploited directly by search engine as facet for example)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
FieldDescription(String fieldName, String content, String lang)
FieldDescription(String fieldName, String content, String lang, boolean stored)
FieldDescription(String fieldName, Date date, String lang, boolean stored)
FieldDescription(String fieldName, Date begin, Date end, String lang)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getContent()	Return the content itself
LocalDate	getEndDate()
String	getFieldName()	Return the fieldName
String	getLang()	Return the content language
LocalDate	getStartDate()
int	hashCode()
boolean	isBasedOnDate()
boolean	isEmpty()
boolean	isStored()

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldDescription

public FieldDescription(String fieldName,
                        String content,
                        String lang)

FieldDescription

public FieldDescription(String fieldName,
                        String content,
                        String lang,
                        boolean stored)

FieldDescription

public FieldDescription(String fieldName,
                        Date date,
                        String lang,
                        boolean stored)

FieldDescription

public FieldDescription(String fieldName,
                        Date begin,
                        Date end,
                        String lang)

Method Detail

isBasedOnDate

public boolean isBasedOnDate()

getFieldName

public String getFieldName()

Return the fieldName

getContent

public String getContent()

Return the content itself

getLang

public String getLang()

Return the content language

isStored

public boolean isStored()

getStartDate

public LocalDate getStartDate()

getEndDate

public LocalDate getEndDate()

isEmpty

public boolean isEmpty()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object