com.swfit.core.xhtml.publish
Class XHTMLPubObjLstDefault

java.lang.Object
  |
  +--java.util.Dictionary
        |
        +--java.util.Hashtable
              |
              +--com.swfit.core.xhtml.publish.XHTMLPublishedObjectList
                    |
                    +--com.swfit.core.xhtml.publish.XHTMLPubObjLstDefault

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map, java.io.Serializable

public class XHTMLPubObjLstDefault

extends XHTMLPublishedObjectList

The XHTMLPubObjLstDefault is the default extension of the XHTMLPublishedObjectList, with default implementations of the abstract methods.

Since:

SWFIT1.0

Version:

$Revision: 1.2 $ $Date: 2003/04/20 13:14:00 $

Author:

Olaf Havnes

See Also:

Serialized Form

Inner classes inherited from class java.util.Map

java.util.Map.Entry

Field Summary

static java.lang.String	ARTICLES_LIST
static java.lang.String	CATEGORY_LIST
static java.lang.String	CREATED_LIST
static int	DEFAULT_NUM_PUBLISH Write the different lists of categories - this one is a hack that relies heavily on SSI.
static java.lang.String	FRESH_LIST
static java.lang.String	LINK_STR
static java.lang.String	LINK_TXT_STR
static java.lang.String	MEDIA_STR
static java.lang.String	MODIFIED_LIST
static java.lang.String	NUM_FRESH_ARTICLES
static int	NUM_FRESH_ARTICLES_DEFAULT
static java.lang.String	NUM_LINK_STR
static java.lang.String	NUM_MEDIA_STR
static java.lang.String	NUM_PUBLISH_NEWS
static java.lang.String	NUM_PUBLISH_NEWSBRIEFS
static java.lang.String	ORDER_LIST
static java.lang.String	PUB_C_DATE_LONG
static java.lang.String	PUB_C_DATE_SHORT
static java.lang.String	PUB_IM_CREDITS
static java.lang.String	PUB_IMAGE
static java.lang.String	PUB_IMAGE_TITLE
static java.lang.String	PUB_M_DATE_LONG
static java.lang.String	PUB_M_DATE_SHORT
static java.lang.String	PUB_POST
static java.lang.String	PUB_TITLE
static java.lang.String	PUB_URL_TXT
static java.lang.String	PUB_URL_VAL
static java.lang.String	PUB_USER
static java.lang.String	PUB_USERBIO
static java.lang.String	PUB_USERMAIL
static java.lang.String	TEXT_STR
static java.lang.String	TICK_TEXT
static java.lang.String	TICK_URL
static java.lang.String	TITLE_LIST
static java.lang.String	TRANSLATION_STR

Fields inherited from class com.swfit.core.xhtml.publish.XHTMLPublishedObjectList

CAT, CREATED_SORT, DEFAULT_SORT, DESCRIPTION_SORT, MAX_CODE, MAX_DESCRIPTION_SIZE, MODIFIED_SORT, NUM, ORDER_SORT, publish_folder, SORT_METHOD_TYPES, SORT_METHODS, SSI_DISABLE

Constructor Summary

XHTMLPubObjLstDefault(XHTMLPublishFolder publish_folder, int type)
Build the XHTMLPubObjLstDefault from various inputs.

Method Summary

protected XHTMLPublishedObject	blankObject(int id) All XHTMLPublishedObjectLists must implement this method to put their mark on the XHTMLPublishedObject.
java.io.File	defaultXHTMLRepresentation() All XHTMLPublishedObjectLists should point to some XHTML representation so that searches will have somewhere to point no matter what kind of list it is.
protected java.lang.String	describeObject(XHTMLPublishedObject xpobj) All XHTMLPublishedObjectLists must implement this method to generate lists for the user interface.
protected java.lang.StringBuffer	displayObject(java.lang.StringBuffer str_b, XHTMLPublishedObject xpobj) All XHTMLPublishedObjectLists must implement this method to generate a brief XHTML list of all the XHTMLPublishedObjects.
XHTMLPublishedObject[]	displaySorted() Sort the contents of this list for export to a single XHTML file.
void	exportXHTMLPublishedObject(XHTMLPublishedObject xpobj) Export a XHTMLPublishedObject.
void	generateOutLists() Should this XHTMLPublishedObjectList generate some lists to be used by flash / SSI ?
protected java.lang.String	objectListTitle(XHTMLPublishedObject xpobj) All XHTMLPublishedObjectLists must implement this method to sub-sort the list of XHTMLPublishedObject.
java.lang.String[][]	outFiles() Should the content of this XHTMLPublishedObjectLists be exported to a set of flash digestable files?
protected void	prepareGet(XHTMLPublishedObject xpobj)
protected void	preparePut(XHTMLPublishedObject xpobj) We handle the extra information during these calls.
protected void	prepareRemove(XHTMLPublishedObject xpobj)
java.lang.String	searchXHTMLPublishedObject(XHTMLPublishedObject xpobj) All XHTMLPublishedObjectLists must implement this method to store a searchable version of the XHTMLPublishedObject in the LuceneIndex.
java.lang.StringBuffer	subImageList(XHTMLPublishedObject[] sorted, int size)
java.lang.String	typeCode() All XHTMLPublishedObjectLists should have a unique String code as a virtual directory for the Lucene index.
void	writeArticleLists() Write the different lists of articles
void	writeMediaLists() Write the different lists of images.
void	writeSubArticleLists(XHTMLPublishedObject[] xpobjs, int num_fresh, java.lang.String prefix, java.lang.String list_name) Sub-sort the lists of articles
void	writeTextLists()
void	writeTickerLists() Write the different lists of tickers
java.io.File	XHTMLRepresentation(XHTMLPublishedObject xpobj)

Methods inherited from class com.swfit.core.xhtml.publish.XHTMLPublishedObjectList

all, allSorted, articleRenderer, authorList, categoryList, categorySorted, chopDescription, createXHTMLPublishedObject, createXHTMLPublishedObject, dataFile, describeXHTMLPublishedObject, descriptionAndID, displayObject, doSort, FlashFile, getAuthor, getCategory, getMedia, getXHTMLPublishedObject, ImageListFile, loadData, mediaList, newCode, objectURLString, outfileSorted, putXHTMLPublishedObject, removeXHTMLPublishedObject, saveDefaultXHTMLRepresentation, setAuthorList, setCategoryList, setMediaList, storeData, subFolder, XHTMLFile, XHTMLListFile

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TEXT_STR

public static final java.lang.String TEXT_STR

TRANSLATION_STR

public static final java.lang.String TRANSLATION_STR

NUM_MEDIA_STR

public static final java.lang.String NUM_MEDIA_STR

MEDIA_STR

public static final java.lang.String MEDIA_STR

NUM_LINK_STR

public static final java.lang.String NUM_LINK_STR

LINK_STR

public static final java.lang.String LINK_STR

LINK_TXT_STR

public static final java.lang.String LINK_TXT_STR

TICK_TEXT

public static final java.lang.String TICK_TEXT

TICK_URL

public static final java.lang.String TICK_URL

DEFAULT_NUM_PUBLISH

public static final int DEFAULT_NUM_PUBLISH

Write the different lists of categories - this one is a hack that relies heavily on SSI.

NUM_PUBLISH_NEWSBRIEFS

public static final java.lang.String NUM_PUBLISH_NEWSBRIEFS

NUM_PUBLISH_NEWS

public static final java.lang.String NUM_PUBLISH_NEWS

PUB_USER

public static final java.lang.String PUB_USER

PUB_USERMAIL

public static final java.lang.String PUB_USERMAIL

PUB_USERBIO

public static final java.lang.String PUB_USERBIO

PUB_URL_VAL

public static final java.lang.String PUB_URL_VAL

PUB_URL_TXT

public static final java.lang.String PUB_URL_TXT

PUB_TITLE

public static final java.lang.String PUB_TITLE

PUB_POST

public static final java.lang.String PUB_POST

PUB_IMAGE

public static final java.lang.String PUB_IMAGE

PUB_IMAGE_TITLE

public static final java.lang.String PUB_IMAGE_TITLE

PUB_IM_CREDITS

public static final java.lang.String PUB_IM_CREDITS

PUB_C_DATE_SHORT

public static final java.lang.String PUB_C_DATE_SHORT

PUB_C_DATE_LONG

public static final java.lang.String PUB_C_DATE_LONG

PUB_M_DATE_SHORT

public static final java.lang.String PUB_M_DATE_SHORT

PUB_M_DATE_LONG

public static final java.lang.String PUB_M_DATE_LONG

ARTICLES_LIST

public static final java.lang.String ARTICLES_LIST

MODIFIED_LIST

public static final java.lang.String MODIFIED_LIST

ORDER_LIST

public static final java.lang.String ORDER_LIST

CREATED_LIST

public static final java.lang.String CREATED_LIST

TITLE_LIST

public static final java.lang.String TITLE_LIST

CATEGORY_LIST

public static final java.lang.String CATEGORY_LIST

FRESH_LIST

public static final java.lang.String FRESH_LIST

NUM_FRESH_ARTICLES

public static final java.lang.String NUM_FRESH_ARTICLES

NUM_FRESH_ARTICLES_DEFAULT

public static final int NUM_FRESH_ARTICLES_DEFAULT

Constructor Detail

XHTMLPubObjLstDefault

public XHTMLPubObjLstDefault(XHTMLPublishFolder publish_folder,
                             int type)

Build the XHTMLPubObjLstDefault from various inputs.

Method Detail

describeObject

protected java.lang.String describeObject(XHTMLPublishedObject xpobj)

All XHTMLPublishedObjectLists must implement this method to generate lists for the user interface.

Overrides:

describeObject in class XHTMLPublishedObjectList

objectListTitle

protected final java.lang.String objectListTitle(XHTMLPublishedObject xpobj)
                                          throws java.io.IOException

All XHTMLPublishedObjectLists must implement this method to sub-sort the list of XHTMLPublishedObject.

Overrides:

objectListTitle in class XHTMLPublishedObjectList

displayObject

protected java.lang.StringBuffer displayObject(java.lang.StringBuffer str_b,
                                               XHTMLPublishedObject xpobj)
                                        throws java.io.IOException

All XHTMLPublishedObjectLists must implement this method to generate a brief XHTML list of all the XHTMLPublishedObjects.

Overrides:

displayObject in class XHTMLPublishedObjectList

blankObject

protected XHTMLPublishedObject blankObject(int id)

All XHTMLPublishedObjectLists must implement this method to put their mark on the XHTMLPublishedObject.

Overrides:

blankObject in class XHTMLPublishedObjectList

preparePut

protected final void preparePut(XHTMLPublishedObject xpobj)
                         throws java.io.IOException

We handle the extra information during these calls.

Overrides:

preparePut in class XHTMLPublishedObjectList

exportXHTMLPublishedObject

public final void exportXHTMLPublishedObject(XHTMLPublishedObject xpobj)
                                      throws java.io.IOException

Description copied from class: XHTMLPublishedObjectList

Export a XHTMLPublishedObject.

Overrides:

exportXHTMLPublishedObject in class XHTMLPublishedObjectList

prepareGet

protected final void prepareGet(XHTMLPublishedObject xpobj)
                         throws java.io.IOException

Overrides:

prepareGet in class XHTMLPublishedObjectList

prepareRemove

protected final void prepareRemove(XHTMLPublishedObject xpobj)
                            throws java.io.IOException

Overrides:

prepareRemove in class XHTMLPublishedObjectList

searchXHTMLPublishedObject

public final java.lang.String searchXHTMLPublishedObject(XHTMLPublishedObject xpobj)

All XHTMLPublishedObjectLists must implement this method to store a searchable version of the XHTMLPublishedObject in the LuceneIndex.

Overrides:

searchXHTMLPublishedObject in class XHTMLPublishedObjectList

defaultXHTMLRepresentation

public final java.io.File defaultXHTMLRepresentation()

All XHTMLPublishedObjectLists should point to some XHTML representation so that searches will have somewhere to point no matter what kind of list it is.

Overrides:

defaultXHTMLRepresentation in class XHTMLPublishedObjectList

XHTMLRepresentation

public final java.io.File XHTMLRepresentation(XHTMLPublishedObject xpobj)

Overrides:

XHTMLRepresentation in class XHTMLPublishedObjectList

outFiles

public final java.lang.String[][] outFiles()

Should the content of this XHTMLPublishedObjectLists be exported to a set of flash digestable files?

Overrides:

outFiles in class XHTMLPublishedObjectList

typeCode

public final java.lang.String typeCode()

All XHTMLPublishedObjectLists should have a unique String code as a virtual directory for the Lucene index.

Overrides:

typeCode in class XHTMLPublishedObjectList

displaySorted

public final XHTMLPublishedObject[] displaySorted()

Sort the contents of this list for export to a single XHTML file.

Overrides:

displaySorted in class XHTMLPublishedObjectList

generateOutLists

public final void generateOutLists()
                            throws java.io.IOException

Should this XHTMLPublishedObjectList generate some lists to be used by flash / SSI ?

Overrides:

generateOutLists in class XHTMLPublishedObjectList

writeMediaLists

public final void writeMediaLists()
                           throws java.io.IOException

Write the different lists of images.

subImageList

public final java.lang.StringBuffer subImageList(XHTMLPublishedObject[] sorted,
                                                 int size)
                                          throws java.io.IOException

writeTickerLists

public final void writeTickerLists()
                            throws java.io.IOException

Write the different lists of tickers

writeTextLists

public final void writeTextLists()
                          throws java.io.IOException

writeArticleLists

public final void writeArticleLists()
                             throws java.io.IOException

Write the different lists of articles

writeSubArticleLists

public void writeSubArticleLists(XHTMLPublishedObject[] xpobjs,
                                 int num_fresh,
                                 java.lang.String prefix,
                                 java.lang.String list_name)
                          throws java.io.IOException

Sub-sort the lists of articles