planetj.helpers
Class FileDescriptor

java.lang.Object
  planetj.helpers.FileDescriptor

Direct Known Subclasses:

CSVFileDescriptor, FDFFileDescriptor, HTMLReportFileDescriptor, IIFFileDescriptor, MSAccessDescriptor, PDFFileDescriptor, QIFFileDescriptor, XMLFileDescriptor

public class FileDescriptor

extends java.lang.Object

FileDescriptor holds common/generic attributes about a file. FileDescriptor is to only be created via planetj.helpers.Helper.newFileDescriptor(); Creation date: (1/21/2002 7:16:24 PM)

Field Summary

static byte	COLUMN_HEADINGS_EXTERNAL Use external names for column headings
static byte	COLUMN_HEADINGS_INTERNAL Use internal column headings
static byte	COLUMN_HEADINGS_NONE Do not use column headings
static char	OUTPUT_ROWS_ALL Display all rows which meet the current criteria
static char	OUTPUT_ROWS_SCREEN Output all rows on the current screen
static char	OUTPUT_ROWS_SELECTED Output only rows which have been selected by the user

Method Summary

byte	getColumnHeadingsDisplayType() Gets the type of column headings to display
java.util.List	getDisplayColumns() Gets the names of the columns to display.
java.lang.String	getFileName() Returns the file name of the CSV file
java.lang.Class	getGeneratorClass() Get the class which should be used to generate the file
char	getOutputRowType() Describes which rows should be output
java.lang.String	getPassword() Insert the method's description here.
java.lang.Object	getPropertyGroup() Gets the property group from which this descriptor was created (may be null)
java.lang.Object	getPropertyValue(java.lang.String propertyName) Gets the specified property contained in the property group
java.lang.String	getSystemName() Insert the method's description here.
java.lang.String	getUserId() Insert the method's description here.
boolean	isAppendToFile() If the file exists, should we append to that file? Creation date: (12/4/2001 10:24:08 PM)
void	setAppendToFile(boolean newAppendToFile) If you want the existing CSV file to simply be appended to, set this value to true Defaults to false Creation date: (12/4/2001 10:24:08 PM)
void	setColumnHeadingsDisplayType(byte newColumnHeadingsDisplay) Gets the type of column headings to display
void	setDisplayColumns(java.util.List columnNames) Sets the names of the columns to display.
void	setFileName(java.lang.String newFileName) This must be the qualified file name (i.e.
void	setGeneratorClass(java.lang.Class generatorClass) Set the class which should be used to generate the file
void	setOutputRowType(char newOutputRowType) Describes which rows should be output
void	setPassword(java.lang.String newPassword) Insert the method's description here.
void	setSystemName(java.lang.String newSystemName) Insert the method's description here.
void	setUserId(java.lang.String newUserId) Insert the method's description here.

Methods inherited from class java.lang.Object

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

Field Detail

COLUMN_HEADINGS_NONE

public static final byte COLUMN_HEADINGS_NONE

Do not use column headings

See Also:

Constant Field Values

COLUMN_HEADINGS_INTERNAL

public static final byte COLUMN_HEADINGS_INTERNAL

Use internal column headings

See Also:

Constant Field Values

COLUMN_HEADINGS_EXTERNAL

public static final byte COLUMN_HEADINGS_EXTERNAL

Use external names for column headings

See Also:

Constant Field Values

OUTPUT_ROWS_ALL

public static final char OUTPUT_ROWS_ALL

Display all rows which meet the current criteria

See Also:

Constant Field Values

OUTPUT_ROWS_SCREEN

public static final char OUTPUT_ROWS_SCREEN

Output all rows on the current screen

See Also:

Constant Field Values

OUTPUT_ROWS_SELECTED

public static final char OUTPUT_ROWS_SELECTED

Output only rows which have been selected by the user

See Also:

Constant Field Values

Method Detail

getColumnHeadingsDisplayType

public byte getColumnHeadingsDisplayType()

Gets the type of column headings to display

getDisplayColumns

public java.util.List getDisplayColumns()

Gets the names of the columns to display. If this is null, then all columns should be displayed.

getFileName

public java.lang.String getFileName()

Returns the file name of the CSV file

If there is no file name specified in here or mFileName is null, then the caller did not want to have a file created, because maybe they may want to display the CSV StringBuffer in a browser or do more analysis of it.

Creation date: (12/4/2001 10:24:08 PM)

Returns:

java.lang.String

getGeneratorClass

public java.lang.Class getGeneratorClass()

Get the class which should be used to generate the file

getOutputRowType

public char getOutputRowType()

Describes which rows should be output

getPassword

public java.lang.String getPassword()

Insert the method's description here. Creation date: (4/23/2002 10:40:11 AM)

Returns:

java.lang.String

getPropertyGroup

public java.lang.Object getPropertyGroup()

Gets the property group from which this descriptor was created (may be null)

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.String propertyName)

Gets the specified property contained in the property group

getSystemName

public java.lang.String getSystemName()

Insert the method's description here. Creation date: (4/23/2002 10:40:11 AM)

Returns:

java.lang.String

getUserId

public java.lang.String getUserId()

Insert the method's description here. Creation date: (4/23/2002 10:40:11 AM)

Returns:

java.lang.String

isAppendToFile

public boolean isAppendToFile()

If the file exists, should we append to that file? Creation date: (12/4/2001 10:24:08 PM)

Returns:

boolean true will append to existing file, false will start with a fresh file.

setAppendToFile

public void setAppendToFile(boolean newAppendToFile)

If you want the existing CSV file to simply be appended to, set this value to true Defaults to false Creation date: (12/4/2001 10:24:08 PM)

Parameters:

newAppendToFile - boolean

setColumnHeadingsDisplayType

public void setColumnHeadingsDisplayType(byte newColumnHeadingsDisplay)

Gets the type of column headings to display

setDisplayColumns

public void setDisplayColumns(java.util.List columnNames)

Sets the names of the columns to display. If this is null, then all columns should be displayed.

setFileName

public void setFileName(java.lang.String newFileName)

This must be the qualified file name (i.e. C:\\Temp\\Test.csv)

If there is no file name specified in here or mFileName is null, then the caller did not want to have a file created, because maybe they may want to display the CSV StringBuffer in a browser or do more analysis of it.

Creation date: (12/4/2001 10:24:08 PM)

Parameters:

newFileName - java.lang.String

setGeneratorClass

public void setGeneratorClass(java.lang.Class generatorClass)

Set the class which should be used to generate the file

setOutputRowType

public void setOutputRowType(char newOutputRowType)

Describes which rows should be output

setPassword

public void setPassword(java.lang.String newPassword)

Insert the method's description here. Creation date: (4/23/2002 10:40:11 AM)

Parameters:

newPassword - java.lang.String

setSystemName

public void setSystemName(java.lang.String newSystemName)

Insert the method's description here. Creation date: (4/23/2002 10:40:11 AM)

Parameters:

newSystemName - java.lang.String

setUserId

public void setUserId(java.lang.String newUserId)

Insert the method's description here. Creation date: (4/23/2002 10:40:11 AM)

Parameters:

newUserId - java.lang.String