com.swfit.core.search
Class MailListCategory

java.lang.Object
  |
  +--com.swfit.core.search.BasicSearchObject
        |
        +--com.swfit.core.search.MailListCategory

public final class MailListCategory

extends BasicSearchObject

Implementation of the BasicSearchObject for categories and sub-categories under the MailList servlet.

Since:

SWFIT1.0

Version:

$Revision: 1.5 $ $Date: 2003/03/21 07:10:06 $

Author:

Olaf Havnes

Field Summary

static java.lang.String	CATEGORY
static java.lang.String	CATEGORY_CODE
static java.lang.String	CATEGORY_DESCRIPTION_EXPLAINER
static java.lang.String	CATEGORY_NAME_EXPLAINER
static java.lang.String	MAIL_LIST_CATEGORY
static java.lang.String	MAX_CODE
static java.lang.String	MLC_DISPLAY_NAME
static java.lang.String	MLC_SELECT_EXPLAINER
static int	NUM_BLANK_SUB_CATEGORIES
static XHTMLFieldCollection	SUB_CATEGORY_DUMMY
static java.lang.String	SUB_CATEGORY_EXPLAINER

Fields inherited from class com.swfit.core.search.BasicSearchObject

ACCESSED, CODE, CONFIRM, CREATED, CREATED_SORT, DATE_CREATED_EXPLAINER, DATE_FORM, DATE_MODIFIED_EXPLAINER, DESCRIPTION, DOC_RSS_FIELD, GET_ACCESSED, GET_CODE, GET_CONFIRM, GET_DESCRIPTION, GET_INDEX, GET_LINK, GET_NAME, GET_SELECT, GET_SYSTEXT, GET_ULTRA, INDEX, INDEX_SORT, LINK, META_FORM, MODIFIED, MODIFIED_SORT, NAME, NAME_SORT, RSS_DESCRIPTION, RSS_LINK, RSS_NAME, search_words, SEARCH_WORDS, SELECT, SELECT_FORM, SYSTEXT, SYSTEXT_SORT, TEXT_FORM, ULTRA, UNDEFINED_SORT

Method Summary

protected BasicSearchObject	create(java.util.Hashtable bsos, XHTMLBasicServlet basic_servlet, MaxCode max_code, int code) Overridden by sub-classes.
static BasicSearchObject	creatorMLC() Get a handle on the MailListCategory create methods.
protected void	fromFormExtra(XHTMLFieldCollection fc) As usual we need to take precautions when reading from a form.
protected void	fromRSSItemExtra(RSSTag item)
void	invalidateExtra()
protected java.lang.String	newDisplayName()
int	newMaxCode()
protected java.lang.String	selectExplainer()
void	setSubCategory(com.swfit.core.search.MailListSubCategory mlsc)
com.swfit.core.search.MailListSubCategory[]	subCategories()
com.swfit.core.search.MailListSubCategory	subCategory(int sub_code)
protected void	toDocumentExtra(org.apache.lucene.document.Document doc) Overridden by subclasses.
protected void	toFormExtra(XHTMLFieldCollection fc, int ndx) We supply a couple of extra MailListSubCategory fields for the form
protected void	toRSSItemExtra(RSSTag item)
java.lang.String	type() For retrieveng a list of similar BasicSearchObjects.
protected boolean	useFrozenName() As long as the names are kept unique, it should be possible to change them.
protected boolean	useSafeName() Names should be unique.

Methods inherited from class com.swfit.core.search.BasicSearchObject

accessed, cleanUp, code, created, dateForm, description, displayText, document, ensureByCode, filterText, fromForm, getAllSorted, getAllSorted, getByCode, getByCode, getBySafeName, getCodeFromForm, getConfirmFromForm, getSelectFromForm, handle, index, invalidate, link, loadAll, loadAll, loadPassive, loadSingle, metaForm, modified, name, passive, publishLocale, safeName, safeNameLetters, selectForm, selectForm, setAccessed, setAccessed, setAccessed, setCreated, setCreated, setDescription, setIndex, setIndex, setLink, setModified, setModified, setName, setSearchWords, setSystext, setUltra, setUltra, sort, systext, textForm, toDocument, toForm, toRSSItem, ultra, valid, validExtra

Methods inherited from class java.lang.Object

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

Field Detail

CATEGORY

public static final java.lang.String CATEGORY

CATEGORY_CODE

public static final java.lang.String CATEGORY_CODE

MAIL_LIST_CATEGORY

public static final java.lang.String MAIL_LIST_CATEGORY

MLC_DISPLAY_NAME

public static final java.lang.String MLC_DISPLAY_NAME

MLC_SELECT_EXPLAINER

public static final java.lang.String MLC_SELECT_EXPLAINER

NUM_BLANK_SUB_CATEGORIES

public static final int NUM_BLANK_SUB_CATEGORIES

MAX_CODE

public static final java.lang.String MAX_CODE

CATEGORY_NAME_EXPLAINER

public static final java.lang.String CATEGORY_NAME_EXPLAINER

CATEGORY_DESCRIPTION_EXPLAINER

public static final java.lang.String CATEGORY_DESCRIPTION_EXPLAINER

SUB_CATEGORY_EXPLAINER

public static final java.lang.String SUB_CATEGORY_EXPLAINER

SUB_CATEGORY_DUMMY

public static final XHTMLFieldCollection SUB_CATEGORY_DUMMY

Method Detail

type

public final java.lang.String type()

Description copied from class: BasicSearchObject

For retrieveng a list of similar BasicSearchObjects.

Overrides:

type in class BasicSearchObject

useSafeName

protected final boolean useSafeName()

Names should be unique.

Overrides:

useSafeName in class BasicSearchObject

useFrozenName

protected final boolean useFrozenName()

As long as the names are kept unique, it should be possible to change them.

Overrides:

useFrozenName in class BasicSearchObject

creatorMLC

public static final BasicSearchObject creatorMLC()

Get a handle on the MailListCategory create methods.

create

protected BasicSearchObject create(java.util.Hashtable bsos,
                                   XHTMLBasicServlet basic_servlet,
                                   MaxCode max_code,
                                   int code)

Description copied from class: BasicSearchObject

Overridden by sub-classes.

Overrides:

create in class BasicSearchObject

newDisplayName

protected final java.lang.String newDisplayName()

Overrides:

newDisplayName in class BasicSearchObject

selectExplainer

protected final java.lang.String selectExplainer()

Overrides:

selectExplainer in class BasicSearchObject

invalidateExtra

public void invalidateExtra()

Overrides:

invalidateExtra in class BasicSearchObject

newMaxCode

public final int newMaxCode()

subCategories

public final com.swfit.core.search.MailListSubCategory[] subCategories()

subCategory

public final com.swfit.core.search.MailListSubCategory subCategory(int sub_code)

setSubCategory

public final void setSubCategory(com.swfit.core.search.MailListSubCategory mlsc)

toRSSItemExtra

protected final void toRSSItemExtra(RSSTag item)

Overrides:

toRSSItemExtra in class BasicSearchObject

fromRSSItemExtra

protected void fromRSSItemExtra(RSSTag item)

Overrides:

fromRSSItemExtra in class BasicSearchObject

toDocumentExtra

protected final void toDocumentExtra(org.apache.lucene.document.Document doc)

Description copied from class: BasicSearchObject

Overridden by subclasses.

Overrides:

toDocumentExtra in class BasicSearchObject

toFormExtra

protected final void toFormExtra(XHTMLFieldCollection fc,
                                 int ndx)

We supply a couple of extra MailListSubCategory fields for the form

Overrides:

toFormExtra in class BasicSearchObject

fromFormExtra

protected final void fromFormExtra(XHTMLFieldCollection fc)

As usual we need to take precautions when reading from a form.

Overrides:

fromFormExtra in class BasicSearchObject