org.silverpeas.search.indexEngine.model
Class FieldDescription

java.lang.Object
  org.silverpeas.search.indexEngine.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

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

FieldDescription(String fieldName, String content, String lang)

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

Method Summary

String	getContent() Return the content itself
String	getFieldName() Return the fieldName
String	getLang() Return the content language
boolean	isStored()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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 begin,
                        Date end,
                        String lang)

Method Detail

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()