com.swfit.core.xhtml.publish
Class XHTMLPublishFolder

java.lang.Object
  |
  +--java.io.File
        |
        +--com.swfit.core.xhtml.publish.XHTMLPublishFolder

All Implemented Interfaces:

java.lang.Comparable, java.io.Serializable

public final class XHTMLPublishFolder

extends java.io.File

A XHTMLPublishFolder is a folder to publish into, where several additional resources might be stored. These resources might include a XHTMLDocument or a config file. These resources should be looked for recursively.

Since:

SWFIT1.0

Version:

$Revision: 1.1 $ $Date: 2003/02/02 20:47:25 $

Author:

Olaf Havnes

See Also:

Serialized Form

Field Summary

static int	ARTICLE
static java.lang.String	ATTACH_FOLDER
static int	AUTHOR
static int	CATEGORY
static java.lang.String	DATA_FILE_TYPE
static java.lang.String[]	DATA_FILES
static java.lang.String	DEFAULT_OUT_FILE
static int	FAQ
static int	FILE
static java.lang.String	FILES_FOLDER
static java.lang.String	FLA_FILE_TYPE
static java.lang.String[]	HIDE_DIRS
static java.lang.String	IMAGES_FOLDER
static java.lang.String	IMS_FOLDER
static java.lang.String	MAIL_FOLDER
static int	MEDIA
static int	NEWS
static int	NEWSBRIEF
static java.lang.String	NUM
static java.lang.String	PUBLISH_XHTML_DUMMY
static java.lang.String	ROOT_DIRECTORY
static java.lang.String	SEARCH_FOLDER
static java.lang.String	SHTML_FILE_TYPE
static java.lang.String	SHTML_LIST_TYPE
static java.lang.String[]	SUB_SYS_DIRS
static java.lang.String[]	SYS_DIRS
static java.lang.String	SYSTEM_XHTML_DUMMY
static int	TICKER
static java.lang.String	UPLOADS_FOLDER
static java.lang.String	WEB_ROOT

Fields inherited from class java.io.File

pathSeparator, pathSeparatorChar, separator, separatorChar

Constructor Summary

XHTMLPublishFolder(javax.servlet.ServletConfig config)

Method Summary

java.io.File	attachFolder()
java.io.File	dataFile(int which) Get the input data file for a specific list
java.io.File	defaultXHTMLOutFile(int which) Get the default output XHTML file for a specific list
java.io.File	filesFolder()
java.lang.String	fileWebRoot()
java.lang.String[]	folderList()
javax.servlet.ServletConfig	folderServletConfig()
java.io.File	imagesFolder()
int[]	imageSizes() Get a set of Image sizes for a specific folder
java.lang.String	imageWebRoot()
XHTMLPublishedObjectIndex	indexer() Get the Lucene indexer for this publish folder.
java.io.File	mailFolder()
BasicSearchObjectIndex	mailIndexer() Get the Lucene indexer for the mail list for this publish folder.
java.lang.String	mailWebRoot()
java.lang.String[][]	outFiles(int which) Get the possible out-files for a specific list.
static java.lang.String	prettyfiedFileName(java.lang.String file_name)
int	publishLocale() Configure various input locales
XHTMLDocument	publishXHTMLDummy() Look recursively for a XHTMLDocument to go with this publishing folder - or check if the input looks like a URL
java.io.File	searchFolder() Get the different system dirs
void	setSubFolder(XHTMLFormParser parser)
java.lang.String	subFolderName()
java.lang.String	subWebRoot()
XHTMLDocument	systemXHTMLDummy() Look - non recursively - for a XHTMLDocument for system generated messages to go with this publishing folder - or check if the input looks like a URL
java.lang.String	webRoot() Configure the prefix for server generated URLs

Methods inherited from class java.io.File

canRead, canWrite, compareTo, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getName, getParent, getParentFile, getPath, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setLastModified, setReadOnly, toString, toURL

Methods inherited from class java.lang.Object

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

Field Detail

AUTHOR

public static final int AUTHOR

ARTICLE

public static final int ARTICLE

CATEGORY

public static final int CATEGORY

NEWS

public static final int NEWS

NEWSBRIEF

public static final int NEWSBRIEF

TICKER

public static final int TICKER

MEDIA

public static final int MEDIA

FILE

public static final int FILE

FAQ

public static final int FAQ

ROOT_DIRECTORY

public static final java.lang.String ROOT_DIRECTORY

PUBLISH_XHTML_DUMMY

public static final java.lang.String PUBLISH_XHTML_DUMMY

SYSTEM_XHTML_DUMMY

public static final java.lang.String SYSTEM_XHTML_DUMMY

WEB_ROOT

public static final java.lang.String WEB_ROOT

SEARCH_FOLDER

public static final java.lang.String SEARCH_FOLDER

UPLOADS_FOLDER

public static final java.lang.String UPLOADS_FOLDER

MAIL_FOLDER

public static final java.lang.String MAIL_FOLDER

IMS_FOLDER

public static final java.lang.String IMS_FOLDER

ATTACH_FOLDER

public static final java.lang.String ATTACH_FOLDER

SYS_DIRS

public static final java.lang.String[] SYS_DIRS

HIDE_DIRS

public static final java.lang.String[] HIDE_DIRS

IMAGES_FOLDER

public static final java.lang.String IMAGES_FOLDER

FILES_FOLDER

public static final java.lang.String FILES_FOLDER

SUB_SYS_DIRS

public static final java.lang.String[] SUB_SYS_DIRS

DATA_FILES

public static final java.lang.String[] DATA_FILES

NUM

public static final java.lang.String NUM

DEFAULT_OUT_FILE

public static final java.lang.String DEFAULT_OUT_FILE

SHTML_LIST_TYPE

public static final java.lang.String SHTML_LIST_TYPE

SHTML_FILE_TYPE

public static final java.lang.String SHTML_FILE_TYPE

FLA_FILE_TYPE

public static final java.lang.String FLA_FILE_TYPE

DATA_FILE_TYPE

public static final java.lang.String DATA_FILE_TYPE

Constructor Detail

XHTMLPublishFolder

public XHTMLPublishFolder(javax.servlet.ServletConfig config)
                   throws java.io.IOException

Method Detail

setSubFolder

public void setSubFolder(XHTMLFormParser parser)
                  throws java.io.IOException

subFolderName

public java.lang.String subFolderName()

folderList

public java.lang.String[] folderList()

indexer

public final XHTMLPublishedObjectIndex indexer()
                                        throws java.io.IOException

Get the Lucene indexer for this publish folder.

mailIndexer

public final BasicSearchObjectIndex mailIndexer()
                                         throws java.io.IOException

Get the Lucene indexer for the mail list for this publish folder.

folderServletConfig

public javax.servlet.ServletConfig folderServletConfig()

publishXHTMLDummy

public XHTMLDocument publishXHTMLDummy()

Look recursively for a XHTMLDocument to go with this publishing folder - or check if the input looks like a URL

systemXHTMLDummy

public XHTMLDocument systemXHTMLDummy()

Look - non recursively - for a XHTMLDocument for system generated messages to go with this publishing folder - or check if the input looks like a URL

imageSizes

public final int[] imageSizes()

Get a set of Image sizes for a specific folder

dataFile

public final java.io.File dataFile(int which)

Get the input data file for a specific list

defaultXHTMLOutFile

public final java.io.File defaultXHTMLOutFile(int which)

Get the default output XHTML file for a specific list

outFiles

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

Get the possible out-files for a specific list. This would normally be a format that is well suited for flash: news, newsbrief, ticker, faq etc.

prettyfiedFileName

public static final java.lang.String prettyfiedFileName(java.lang.String file_name)

webRoot

public final java.lang.String webRoot()

Configure the prefix for server generated URLs

mailWebRoot

public final java.lang.String mailWebRoot()

subWebRoot

public final java.lang.String subWebRoot()

imageWebRoot

public final java.lang.String imageWebRoot()

fileWebRoot

public final java.lang.String fileWebRoot()

searchFolder

public java.io.File searchFolder()

Get the different system dirs

mailFolder

public java.io.File mailFolder()

attachFolder

public java.io.File attachFolder()

imagesFolder

public java.io.File imagesFolder()

filesFolder

public java.io.File filesFolder()

publishLocale

public final int publishLocale()

Configure various input locales