planetj.helpers.properties
Class FilePropertyGroup

java.lang.Object
  java.util.AbstractMap
      java.util.HashMap
          planetj.property.PropertyGroup
              planetj.property.DefaultPropertyGroup
                  planetj.helpers.properties.FilePropertyGroup

All Implemented Interfaces:

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

Direct Known Subclasses:

CSVPropertyGroup, MSAccessPropertyGroup, PDFPropertyGroup, XLSPropertyGroup, XMLPropertyGroup

public class FilePropertyGroup

extends DefaultPropertyGroup

PropertyGroup for the PDF file format.

See Also:

Serialized Form

Field Summary

static java.lang.String	COLUMN_HEADINGS String property for what column headers to use
static java.lang.String	COLUMN_HEADINGS_EXTERNAL Use external names for column headings
static java.lang.String	COLUMN_HEADINGS_INTERNAL Use internal column headings
static java.lang.String	COLUMN_HEADINGS_NONE Do not use column headings
static java.lang.String	DIRECT_TO_FILE
static java.lang.String	DISPLAY_COLUMNS String property for which columns to process
static java.lang.String	FILE_NAME String property for name of file
static java.lang.String	GENERATOR_CLASS The Java class which should be used to generate the file
static java.lang.String	OUTPUT_ROWS String property for which rows to process
static java.lang.String	OUTPUT_ROWS_ALL Output all rows which meet the current criteria
static java.lang.String	OUTPUT_ROWS_SCREEN Output all rows on the current screen
static java.lang.String	OUTPUT_ROWS_SELECTED Output only rows which have been selected by the user
static java.lang.String	USE_DISPLAY_VALUE

Fields inherited from class planetj.property.PropertyGroup

ALL, ALL_FALSE, ALL_TRUE, BOOLEAN_PROPERTY, DATE_PROPERTY, DOUBLE_PROPERTY, FLOAT_PROPERTY, INTEGER_PROPERTY, JAVA_CLASS_PROPERTY, LIST_PROPERTY, MAP_PROPERTY, NONE, ROW_COLLECTION_KEY, STRING_PROPERTY

Constructor Summary

FilePropertyGroup()
FilePropertyGroup constructor comment.

FilePropertyGroup(int initialCapacity)
FilePropertyGroup constructor comment.

FilePropertyGroup(java.lang.String pName)
FilePropertyGroup constructor comment.

Method Summary

java.util.List	getAllPropertyNames() Gets a List containing the names of all the supported properties, not including metaproperties.
byte	getColumnHeadingsDisplayType() Gets the byte value (defined in FileDescriptor) indicating what to display for column headings
java.util.List	getDisplayColumns() Gets the List of columns names which should be displayed (may be null)
java.lang.Class	getGeneratorClass() Get the class which should be used to generate the file
char	getOutputRowType() Gets the char value (defined in FileDescriptor) indicating which rows to output
java.util.List	getRequiredPropertyNames() Gets a List containing the names of all the required properties.
boolean	isUseDisplayValues() Check to see if display values should be used instead of actual values.

Methods inherited from class planetj.property.DefaultPropertyGroup

getDefaultPropertiesString

Methods inherited from class planetj.property.PropertyGroup

add, addProperty, addProperty, append, clone, compareTo, compareTo, compareTo, containsProperty, copyUndefinedPropertiesFrom, createProperty, getAllMetapropertyNames, getAllSetBooleanPropertyNames, getAllSetIntPropertyNames, getAllSetListPropertyNames, getAllSetPropertyNames, getAllSetStringPropertyNames, getBooleanValue, getDateValue, getDoubleValue, getFloatValue, getIntValue, getJavaClassValue, getListValue, getMapValue, getName, getProperty, getPropertyType, getStringValue, getValue, isMergeableOnList, isMetaproperty, iterator, mergeOnList, put, put, put, setName, toString, updateProperty

Methods inherited from class java.util.HashMap

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

COLUMN_HEADINGS

public static final java.lang.String COLUMN_HEADINGS

String property for what column headers to use

See Also:

Constant Field Values

COLUMN_HEADINGS_NONE

public static final java.lang.String COLUMN_HEADINGS_NONE

Do not use column headings

See Also:

Constant Field Values

COLUMN_HEADINGS_INTERNAL

public static final java.lang.String COLUMN_HEADINGS_INTERNAL

Use internal column headings

See Also:

Constant Field Values

COLUMN_HEADINGS_EXTERNAL

public static final java.lang.String COLUMN_HEADINGS_EXTERNAL

Use external names for column headings

See Also:

Constant Field Values

OUTPUT_ROWS

public static final java.lang.String OUTPUT_ROWS

String property for which rows to process

See Also:

Constant Field Values

OUTPUT_ROWS_ALL

public static final java.lang.String OUTPUT_ROWS_ALL

Output all rows which meet the current criteria

See Also:

Constant Field Values

OUTPUT_ROWS_SCREEN

public static final java.lang.String OUTPUT_ROWS_SCREEN

Output all rows on the current screen

See Also:

Constant Field Values

OUTPUT_ROWS_SELECTED

public static final java.lang.String OUTPUT_ROWS_SELECTED

Output only rows which have been selected by the user

See Also:

Constant Field Values

GENERATOR_CLASS

public static final java.lang.String GENERATOR_CLASS

The Java class which should be used to generate the file

See Also:

Constant Field Values

DISPLAY_COLUMNS

public static final java.lang.String DISPLAY_COLUMNS

String property for which columns to process

See Also:

Constant Field Values

FILE_NAME

public static final java.lang.String FILE_NAME

String property for name of file

See Also:

Constant Field Values

USE_DISPLAY_VALUE

public static final java.lang.String USE_DISPLAY_VALUE

See Also:

Constant Field Values

DIRECT_TO_FILE

public static final java.lang.String DIRECT_TO_FILE

See Also:

Constant Field Values

Constructor Detail

FilePropertyGroup

public FilePropertyGroup()

FilePropertyGroup constructor comment.

FilePropertyGroup

public FilePropertyGroup(int initialCapacity)

FilePropertyGroup constructor comment.

Parameters:

initialCapacity - int

FilePropertyGroup

public FilePropertyGroup(java.lang.String pName)

FilePropertyGroup constructor comment.

Parameters:

pName - java.lang.String

Method Detail

getAllPropertyNames

public java.util.List getAllPropertyNames()

Gets a List containing the names of all the supported properties, not including metaproperties.

Overrides:

getAllPropertyNames in class DefaultPropertyGroup

getColumnHeadingsDisplayType

public byte getColumnHeadingsDisplayType()

Gets the byte value (defined in FileDescriptor) indicating what to display for column headings

getDisplayColumns

public java.util.List getDisplayColumns()

Gets the List of columns names which should be displayed (may be null)

getGeneratorClass

public java.lang.Class getGeneratorClass()

Get the class which should be used to generate the file

getOutputRowType

public char getOutputRowType()

Gets the char value (defined in FileDescriptor) indicating which rows to output

getRequiredPropertyNames

public java.util.List getRequiredPropertyNames()

Gets a List containing the names of all the required properties.

Overrides:

getRequiredPropertyNames in class DefaultPropertyGroup

isUseDisplayValues

public boolean isUseDisplayValues()

Check to see if display values should be used instead of actual values.