org.apache.jetspeed.services.search
Interface ParsedObject

All Known Implementing Classes:

BaseParsedObject

public interface ParsedObject

Contract for implementing a specific parsed object.

Version:

$Id: ParsedObject.java,v 1.4 2004/02/23 03:48:47 jford Exp $

Author:

Mark Orciuch

Field Summary

static java.lang.String	FIELDNAME_CLASSNAME
static java.lang.String	FIELDNAME_CLASSNAME_DEFAULT
static java.lang.String	FIELDNAME_CONTENT
static java.lang.String	FIELDNAME_CONTENT_DEFAULT
static java.lang.String	FIELDNAME_DESCRIPTION
static java.lang.String	FIELDNAME_DESCRIPTION_DEFAULT
static java.lang.String	FIELDNAME_FIELDS
static java.lang.String	FIELDNAME_FIELDS_DEFAULT
static java.lang.String	FIELDNAME_KEY
static java.lang.String	FIELDNAME_KEY_DEFAULT
static java.lang.String	FIELDNAME_KEYWORDS
static java.lang.String	FIELDNAME_KEYWORDS_DEFAULT
static java.lang.String	FIELDNAME_LANGUAGE
static java.lang.String	FIELDNAME_LANGUAGE_DEFAULT
static java.lang.String	FIELDNAME_SCORE
static java.lang.String	FIELDNAME_SCORE_DEFAULT
static java.lang.String	FIELDNAME_TITLE
static java.lang.String	FIELDNAME_TITLE_DEFAULT
static java.lang.String	FIELDNAME_TYPE
static java.lang.String	FIELDNAME_TYPE_DEFAULT
static java.lang.String	FIELDNAME_URL
static java.lang.String	FIELDNAME_URL_DEFAULT
static java.lang.String	OBJECT_TYPE_PDF
static java.lang.String	OBJECT_TYPE_PORTLET
static java.lang.String	OBJECT_TYPE_URL

Method Summary

java.lang.String	getClassName() Getter for property className.
java.lang.String	getContent() Returns parsed object content (cannot be null)
java.lang.String	getDescription() Returns parsed object description (cannot be null)
java.util.Map	getFields() Deprecated. Returns parsed object searchable fields
java.lang.String	getKey() Returns parsed object key (cannot be null)
java.lang.String[]	getKeywords() Deprecated. Returns parsed object keywords
java.lang.String	getLanguage() Returns parsed object language (cannot be null)
org.apache.commons.collections.MultiMap	getMultiFields()
org.apache.commons.collections.MultiMap	getMultiKeywords()
float	getScore() Getter for property score.
java.lang.String	getTitle() Returns parsed object title (cannot be null)
java.lang.String	getType() Returns parsed object type (cannot be null)
java.net.URL	getURL() Returns parsed object URL
void	setClassName(java.lang.String className) Setter for property className.
void	setContent(java.lang.String content) Sets parsed object content (cannot be null)
void	setDescription(java.lang.String description) Sets parsed object description (cannot be null)
void	setFields(java.util.Map fields) Deprecated. Sets parsed object searchable fields
void	setKey(java.lang.String key) Sets parsed object key (cannot be null)
void	setKeywords(java.lang.String[] keywords) Deprecated. Sets parsed object keywords
void	setLanguage(java.lang.String language) Sets parsed object language (cannot be null)
void	setMultiFields(org.apache.commons.collections.MultiMap multiFields)
void	setMultiKeywords(org.apache.commons.collections.MultiMap multiKeywords)
void	setScore(float score) Setter for property score.
void	setTitle(java.lang.String title) Sets parsed object title (cannot be null)
void	setType(java.lang.String type) Sets parsed object type (cannot be null)
void	setURL(java.net.URL url) Sets parsed object URL

Field Detail

FIELDNAME_KEY

public static final java.lang.String FIELDNAME_KEY

See Also:

Constant Field Values

FIELDNAME_KEY_DEFAULT

public static final java.lang.String FIELDNAME_KEY_DEFAULT

See Also:

Constant Field Values

FIELDNAME_TYPE

public static final java.lang.String FIELDNAME_TYPE

See Also:

Constant Field Values

FIELDNAME_TYPE_DEFAULT

public static final java.lang.String FIELDNAME_TYPE_DEFAULT

See Also:

Constant Field Values

FIELDNAME_CONTENT

public static final java.lang.String FIELDNAME_CONTENT

See Also:

Constant Field Values

FIELDNAME_CONTENT_DEFAULT

public static final java.lang.String FIELDNAME_CONTENT_DEFAULT

See Also:

Constant Field Values

FIELDNAME_DESCRIPTION

public static final java.lang.String FIELDNAME_DESCRIPTION

See Also:

Constant Field Values

FIELDNAME_DESCRIPTION_DEFAULT

public static final java.lang.String FIELDNAME_DESCRIPTION_DEFAULT

See Also:

Constant Field Values

FIELDNAME_TITLE

public static final java.lang.String FIELDNAME_TITLE

See Also:

Constant Field Values

FIELDNAME_TITLE_DEFAULT

public static final java.lang.String FIELDNAME_TITLE_DEFAULT

See Also:

Constant Field Values

FIELDNAME_LANGUAGE

public static final java.lang.String FIELDNAME_LANGUAGE

See Also:

Constant Field Values

FIELDNAME_LANGUAGE_DEFAULT

public static final java.lang.String FIELDNAME_LANGUAGE_DEFAULT

See Also:

Constant Field Values

FIELDNAME_FIELDS

public static final java.lang.String FIELDNAME_FIELDS

See Also:

Constant Field Values

FIELDNAME_FIELDS_DEFAULT

public static final java.lang.String FIELDNAME_FIELDS_DEFAULT

See Also:

Constant Field Values

FIELDNAME_KEYWORDS

public static final java.lang.String FIELDNAME_KEYWORDS

See Also:

Constant Field Values

FIELDNAME_KEYWORDS_DEFAULT

public static final java.lang.String FIELDNAME_KEYWORDS_DEFAULT

See Also:

Constant Field Values

FIELDNAME_URL

public static final java.lang.String FIELDNAME_URL

See Also:

Constant Field Values

FIELDNAME_URL_DEFAULT

public static final java.lang.String FIELDNAME_URL_DEFAULT

See Also:

Constant Field Values

FIELDNAME_SCORE

public static final java.lang.String FIELDNAME_SCORE

See Also:

Constant Field Values

FIELDNAME_SCORE_DEFAULT

public static final java.lang.String FIELDNAME_SCORE_DEFAULT

See Also:

Constant Field Values

FIELDNAME_CLASSNAME

public static final java.lang.String FIELDNAME_CLASSNAME

See Also:

Constant Field Values

FIELDNAME_CLASSNAME_DEFAULT

public static final java.lang.String FIELDNAME_CLASSNAME_DEFAULT

See Also:

Constant Field Values

OBJECT_TYPE_URL

public static final java.lang.String OBJECT_TYPE_URL

See Also:

Constant Field Values

OBJECT_TYPE_PORTLET

public static final java.lang.String OBJECT_TYPE_PORTLET

See Also:

Constant Field Values

OBJECT_TYPE_PDF

public static final java.lang.String OBJECT_TYPE_PDF

See Also:

Constant Field Values

Method Detail

getKey

public java.lang.String getKey()

Returns parsed object key (cannot be null)

Returns:

setKey

public void setKey(java.lang.String key)

Sets parsed object key (cannot be null)

getType

public java.lang.String getType()

Returns parsed object type (cannot be null)

Returns:

setType

public void setType(java.lang.String type)

Sets parsed object type (cannot be null)

Parameters:

type -

getContent

public java.lang.String getContent()

Returns parsed object content (cannot be null)

Returns:

setContent

public void setContent(java.lang.String content)

Sets parsed object content (cannot be null)

Parameters:

content -

getDescription

public java.lang.String getDescription()

Returns parsed object description (cannot be null)

Returns:

setDescription

public void setDescription(java.lang.String description)

Sets parsed object description (cannot be null)

Parameters:

description -

getKeywords

public java.lang.String[] getKeywords()

Deprecated. Returns parsed object keywords

Returns:

setKeywords

public void setKeywords(java.lang.String[] keywords)

Deprecated. Sets parsed object keywords

Parameters:

keywords -

getTitle

public java.lang.String getTitle()

Returns parsed object title (cannot be null)

Returns:

setTitle

public void setTitle(java.lang.String title)

Sets parsed object title (cannot be null)

Parameters:

title -

getLanguage

public java.lang.String getLanguage()

Returns parsed object language (cannot be null)

Returns:

setLanguage

public void setLanguage(java.lang.String language)

Sets parsed object language (cannot be null)

Parameters:

language -

getFields

public java.util.Map getFields()

Deprecated. Returns parsed object searchable fields

Returns:

setFields

public void setFields(java.util.Map fields)

Deprecated. Sets parsed object searchable fields

Parameters:

fields -

getMultiFields

public org.apache.commons.collections.MultiMap getMultiFields()

Returns:

setMultiFields

public void setMultiFields(org.apache.commons.collections.MultiMap multiFields)

Parameters:

multiFields -

getMultiKeywords

public org.apache.commons.collections.MultiMap getMultiKeywords()

Returns:

setMultiKeywords

public void setMultiKeywords(org.apache.commons.collections.MultiMap multiKeywords)

Parameters:

multiKeywords -

getURL

public java.net.URL getURL()

Returns parsed object URL

Returns:

setURL

public void setURL(java.net.URL url)

Sets parsed object URL

Parameters:

url -

getScore

public float getScore()

Getter for property score.

Returns:

Value of property score.

setScore

public void setScore(float score)

Setter for property score.

Parameters:

score - New value of property score.

getClassName

public java.lang.String getClassName()

Getter for property className.

Returns:

Value of property className.

setClassName

public void setClassName(java.lang.String className)

Setter for property className.

Parameters:

className - New value of property className.