planetj.helpers.properties
Class FilePropertyGroup

java.lang.Object
  |
  +--java.util.AbstractMap
        |
        +--java.util.HashMap
              |
              +--planetj.property.PropertyGroup
                    |
                    +--planetj.helpers.properties.FilePropertyGroup

All Implemented Interfaces:

Cloneable, Comparable, Map, Serializable

Direct Known Subclasses:

CSVPropertyGroup, MSAccessPropertyGroup, PDFPropertyGroup, XLSPropertyGroup, XMLPropertyGroup

public class FilePropertyGroup

extends PropertyGroup

PropertyGroup for the PDF file format.

See Also:

Serialized Form

Field Summary

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

Fields inherited from class planetj.property.PropertyGroup

ALL_FALSE, ALL_TRUE, BOOLEAN_PROPERTY, DATE_PROPERTY, DOUBLE_PROPERTY, INTEGER_PROPERTY, LIST_PROPERTY, ROW_COLLECTION_KEY, STRING_PROPERTY

Constructor Summary

FilePropertyGroup()
FilePropertyGroup constructor comment.

FilePropertyGroup(int initialCapacity)
FilePropertyGroup constructor comment.

FilePropertyGroup(String pName)
FilePropertyGroup constructor comment.

Method Summary

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
List	getDisplayColumns() Gets the List of columns names which should be displayed (may be null)
char	getOutputRowType() Gets the char value (defined in FileDescriptor) indicating which rows to output
List	getRequiredPropertyNames() Gets a List containing the names of all the required properties.

Methods inherited from class planetj.property.PropertyGroup

add, addProperty, addProperty, append, clone, compareTo, compareTo, compareTo, containsProperty, createProperty, getAllMetapropertyNames, getAllSetBooleanPropertyNames, getAllSetIntPropertyNames, getAllSetListPropertyNames, getAllSetPropertyNames, getAllSetStringPropertyNames, getBooleanValue, getDateValue, getDoubleValue, getIntValue, getListValue, 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 String COLUMN_HEADINGS

String property for what column headers to use

See Also:

Constant Field Values

COLUMN_HEADINGS_NONE

public static final String COLUMN_HEADINGS_NONE

Do not use column headings

See Also:

Constant Field Values

COLUMN_HEADINGS_INTERNAL

public static final String COLUMN_HEADINGS_INTERNAL

Use internal column headings

See Also:

Constant Field Values

COLUMN_HEADINGS_EXTERNAL

public static final String COLUMN_HEADINGS_EXTERNAL

Use external names for column headings

See Also:

Constant Field Values

OUTPUT_ROWS

public static final String OUTPUT_ROWS

String property for which rows to process

See Also:

Constant Field Values

OUTPUT_ROWS_ALL

public static final String OUTPUT_ROWS_ALL

Output all rows which meet the current criteria

See Also:

Constant Field Values

OUTPUT_ROWS_SCREEN

public static final String OUTPUT_ROWS_SCREEN

Output all rows on the current screen

See Also:

Constant Field Values

OUTPUT_ROWS_SELECTED

public static final String OUTPUT_ROWS_SELECTED

Output only rows which have been selected by the user

See Also:

Constant Field Values

DISPLAY_COLUMNS

public static final String DISPLAY_COLUMNS

String property for which columns to process

See Also:

Constant Field Values

FILE_NAME

public static final String FILE_NAME

String property for name of file

See Also:

Constant Field Values

DIRECT_TO_FILE

public static final 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(String pName)

FilePropertyGroup constructor comment.

Parameters:

pName - java.lang.String

Method Detail

getAllPropertyNames

public List getAllPropertyNames()

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

Specified by:

getAllPropertyNames in class PropertyGroup

getColumnHeadingsDisplayType

public byte getColumnHeadingsDisplayType()

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

getDisplayColumns

public List getDisplayColumns()

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

getOutputRowType

public char getOutputRowType()

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

getRequiredPropertyNames

public List getRequiredPropertyNames()

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

Specified by:

getRequiredPropertyNames in class PropertyGroup