org.cishell.framework.data
Interface DataProperty

public interface DataProperty

Standard property keys and values to use when creating metadata for a Data object

Author:

Bruce Herr (bh2@bh2.net)

Field Summary

static String	LABEL The label to give the Data object if displayed.
static String	MATRIX_TYPE Says this data model is abstractly a matrix
static String	MODIFIED Flag to determine if the Data object has been modified and not saved since the modification.
static String	NETWORK_TYPE Says this data model is abstractly a network
static String	OTHER_TYPE Says this data model is abstractly an unknown type
static String	PARENT The parent Data object of the Data object.
static String	PLOT_TYPE Says this data model is abstractly a data plot
static String	SHORT_LABEL A short label to give the Data object for shorter displays.
static String	TABLE_TYPE Says this data model is abstractly a table
static String	TEXT_TYPE Says this data model is abstractly a plain text file
static String	TREE_TYPE Says this data model is abstractly a tree
static String	TYPE The general type of the Data object.

Field Detail

LABEL

static final String LABEL

The label to give the Data object if displayed. The type associated with this property is of type String.

See Also:

Constant Field Values

SHORT_LABEL

static final String SHORT_LABEL

A short label to give the Data object for shorter displays. It is recommended to keep the string length below 20 characters. This will often be used for recommended file names when saving the data to disk. The type associated with this property is of type String.

See Also:

Constant Field Values

PARENT

static final String PARENT

The parent Data object of the Data object. This is used when a Data object is derived from another Data object to show the hierarchical relationship between them. This property can be null, signifying that the Data object was not derived from any other Data object, such as when loading a new Data object from a file. The type associated with this property is of type Data.

See Also:

Constant Field Values

TYPE

static final String TYPE

The general type of the Data object. Various standard types are created as constants with name *_TYPE from this class. These can be used, or new types can be introduced as needed. The type associated with this property is of type String.

See Also:

Constant Field Values

MODIFIED

static final String MODIFIED

Flag to determine if the Data object has been modified and not saved since the modification. This is used to do things like notify the user before they exit that a modified Data object exists and ask if they want to save it. The type associated with this property is of type Boolean.

See Also:

Constant Field Values

MATRIX_TYPE

static final String MATRIX_TYPE

Says this data model is abstractly a matrix

See Also:

Constant Field Values

NETWORK_TYPE

static final String NETWORK_TYPE

Says this data model is abstractly a network

See Also:

Constant Field Values

TABLE_TYPE

static final String TABLE_TYPE

Says this data model is abstractly a table

See Also:

Constant Field Values

TREE_TYPE

static final String TREE_TYPE

Says this data model is abstractly a tree

See Also:

Constant Field Values

OTHER_TYPE

static final String OTHER_TYPE

Says this data model is abstractly an unknown type

See Also:

Constant Field Values

TEXT_TYPE

static final String TEXT_TYPE

Says this data model is abstractly a plain text file

See Also:

Constant Field Values

PLOT_TYPE

static final String PLOT_TYPE

Says this data model is abstractly a data plot

See Also:

Constant Field Values