org.apache.jetspeed.search
Interface ParsedObject


public interface ParsedObject

Contract for implementing a specific parsed object.

Version:
$Id: ParsedObject.java 516448 2007-03-09 16:25:47Z ate $
Author:
Mark Orciuch

Field Summary
static String FIELDNAME_CLASSNAME
           
static String FIELDNAME_CLASSNAME_DEFAULT
           
static String FIELDNAME_CONTENT
           
static String FIELDNAME_CONTENT_DEFAULT
           
static String FIELDNAME_DESCRIPTION
           
static String FIELDNAME_DESCRIPTION_DEFAULT
           
static String FIELDNAME_FIELDS
           
static String FIELDNAME_FIELDS_DEFAULT
           
static String FIELDNAME_KEY
           
static String FIELDNAME_KEY_DEFAULT
           
static String FIELDNAME_KEYWORDS
           
static String FIELDNAME_KEYWORDS_DEFAULT
           
static String FIELDNAME_LANGUAGE
           
static String FIELDNAME_LANGUAGE_DEFAULT
           
static String FIELDNAME_SCORE
           
static String FIELDNAME_SCORE_DEFAULT
           
static String FIELDNAME_TITLE
           
static String FIELDNAME_TITLE_DEFAULT
           
static String FIELDNAME_TYPE
           
static String FIELDNAME_TYPE_DEFAULT
           
static String FIELDNAME_URL
           
static String FIELDNAME_URL_DEFAULT
           
static String OBJECT_TYPE_PDF
           
static String OBJECT_TYPE_PORTLET
           
static String OBJECT_TYPE_PORTLET_APPLICATION
           
static String OBJECT_TYPE_URL
           
 
Method Summary
 String getClassName()
          Getter for property className.
 String getContent()
          Returns parsed object content (cannot be null)
 String getDescription()
          Returns parsed object description (cannot be null)
 Map getFields()
          Returns parsed object searchable fields
 String getKey()
          Returns parsed object key (cannot be null)
 String[] getKeywords()
          Returns parsed object keywords
 Map getKeywordsMap()
           
 String getLanguage()
          Returns parsed object language (cannot be null)
 float getScore()
          Getter for property score.
 String getTitle()
          Returns parsed object title (cannot be null)
 String getType()
          Returns parsed object type (cannot be null)
 URL getURL()
          Returns parsed object URL
 void setClassName(String className)
          Setter for property className.
 void setContent(String content)
          Sets parsed object content (cannot be null)
 void setDescription(String description)
          Sets parsed object description (cannot be null)
 void setFields(Map fields)
          Sets parsed object searchable fields
 void setKey(String key)
          Sets parsed object key (cannot be null)
 void setKeywords(String[] keywords)
          Sets parsed object keywords
 void setKeywordsMap(Map keywordsMap)
           
 void setLanguage(String language)
          Sets parsed object language (cannot be null)
 void setScore(float score)
          Setter for property score.
 void setTitle(String title)
          Sets parsed object title (cannot be null)
 void setType(String type)
          Sets parsed object type (cannot be null)
 void setURL(URL url)
          Sets parsed object URL
 

Field Detail

FIELDNAME_KEY

static final String FIELDNAME_KEY
See Also:
Constant Field Values

FIELDNAME_KEY_DEFAULT

static final String FIELDNAME_KEY_DEFAULT
See Also:
Constant Field Values

FIELDNAME_TYPE

static final String FIELDNAME_TYPE
See Also:
Constant Field Values

FIELDNAME_TYPE_DEFAULT

static final String FIELDNAME_TYPE_DEFAULT
See Also:
Constant Field Values

FIELDNAME_CONTENT

static final String FIELDNAME_CONTENT
See Also:
Constant Field Values

FIELDNAME_CONTENT_DEFAULT

static final String FIELDNAME_CONTENT_DEFAULT
See Also:
Constant Field Values

FIELDNAME_DESCRIPTION

static final String FIELDNAME_DESCRIPTION
See Also:
Constant Field Values

FIELDNAME_DESCRIPTION_DEFAULT

static final String FIELDNAME_DESCRIPTION_DEFAULT
See Also:
Constant Field Values

FIELDNAME_TITLE

static final String FIELDNAME_TITLE
See Also:
Constant Field Values

FIELDNAME_TITLE_DEFAULT

static final String FIELDNAME_TITLE_DEFAULT
See Also:
Constant Field Values

FIELDNAME_LANGUAGE

static final String FIELDNAME_LANGUAGE
See Also:
Constant Field Values

FIELDNAME_LANGUAGE_DEFAULT

static final String FIELDNAME_LANGUAGE_DEFAULT
See Also:
Constant Field Values

FIELDNAME_FIELDS

static final String FIELDNAME_FIELDS
See Also:
Constant Field Values

FIELDNAME_FIELDS_DEFAULT

static final String FIELDNAME_FIELDS_DEFAULT
See Also:
Constant Field Values

FIELDNAME_KEYWORDS

static final String FIELDNAME_KEYWORDS
See Also:
Constant Field Values

FIELDNAME_KEYWORDS_DEFAULT

static final String FIELDNAME_KEYWORDS_DEFAULT
See Also:
Constant Field Values

FIELDNAME_URL

static final String FIELDNAME_URL
See Also:
Constant Field Values

FIELDNAME_URL_DEFAULT

static final String FIELDNAME_URL_DEFAULT
See Also:
Constant Field Values

FIELDNAME_SCORE

static final String FIELDNAME_SCORE
See Also:
Constant Field Values

FIELDNAME_SCORE_DEFAULT

static final String FIELDNAME_SCORE_DEFAULT
See Also:
Constant Field Values

FIELDNAME_CLASSNAME

static final String FIELDNAME_CLASSNAME
See Also:
Constant Field Values

FIELDNAME_CLASSNAME_DEFAULT

static final String FIELDNAME_CLASSNAME_DEFAULT
See Also:
Constant Field Values

OBJECT_TYPE_URL

static final String OBJECT_TYPE_URL
See Also:
Constant Field Values

OBJECT_TYPE_PORTLET

static final String OBJECT_TYPE_PORTLET
See Also:
Constant Field Values

OBJECT_TYPE_PORTLET_APPLICATION

static final String OBJECT_TYPE_PORTLET_APPLICATION
See Also:
Constant Field Values

OBJECT_TYPE_PDF

static final String OBJECT_TYPE_PDF
See Also:
Constant Field Values
Method Detail

getKey

String getKey()
Returns parsed object key (cannot be null)

Returns:

setKey

void setKey(String key)
Sets parsed object key (cannot be null)

Parameters:
type -

getType

String getType()
Returns parsed object type (cannot be null)

Returns:

setType

void setType(String type)
Sets parsed object type (cannot be null)

Parameters:
type -

getContent

String getContent()
Returns parsed object content (cannot be null)

Returns:

setContent

void setContent(String content)
Sets parsed object content (cannot be null)

Parameters:
content -

getDescription

String getDescription()
Returns parsed object description (cannot be null)

Returns:

setDescription

void setDescription(String description)
Sets parsed object description (cannot be null)

Parameters:
description -

getKeywords

String[] getKeywords()
Returns parsed object keywords

Returns:

setKeywords

void setKeywords(String[] keywords)
Sets parsed object keywords

Parameters:
keywords -

getTitle

String getTitle()
Returns parsed object title (cannot be null)

Returns:

setTitle

void setTitle(String title)
Sets parsed object title (cannot be null)

Parameters:
title -

getLanguage

String getLanguage()
Returns parsed object language (cannot be null)

Returns:

setLanguage

void setLanguage(String language)
Sets parsed object language (cannot be null)

Parameters:
language -

getFields

Map getFields()
Returns parsed object searchable fields

Returns:

setFields

void setFields(Map fields)
Sets parsed object searchable fields

Parameters:
fields -

getKeywordsMap

Map getKeywordsMap()
Returns:

setKeywordsMap

void setKeywordsMap(Map keywordsMap)
Parameters:
multiKeywords -

getURL

URL getURL()
Returns parsed object URL

Returns:

setURL

void setURL(URL url)
Sets parsed object URL

Parameters:
url -

getScore

float getScore()
Getter for property score.

Returns:
Value of property score.

setScore

void setScore(float score)
Setter for property score.

Parameters:
score - New value of property score.

getClassName

String getClassName()
Getter for property className.

Returns:
Value of property className.

setClassName

void setClassName(String className)
Setter for property className.

Parameters:
className - New value of property className.


Copyright © 1999-2007 Apache Software Foundation. All Rights Reserved.