AttributeTableRuleSet (cismap Commons [9.2-SNAPSHOT] 9.2-SNAPSHOT API)

All Known Subinterfaces:

H2AttributeTableRuleSet

All Known Implementing Classes:

DefaultAttributeTableRuleSet, DefaultH2AttributeTableRuleSet, H2AttributeTableRuleSet
```
public interface AttributeTableRuleSet
```
DOCUMENT ME!

Version:

$Revision$, $Date$

Author:

therter

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Object`	`afterEdit(FeatureServiceFeature feature, String column, int row, Object oldValue, Object newValue)` This method will be invoked, after a cell was edited.
`void`	`afterSave(TableModel model)` DOCUMENT ME!
`void`	`beforeSave(FeatureServiceFeature feature)` Will be invoked before a the given feature will be saved.
`FeatureServiceFeature`	`cloneFeature(FeatureServiceFeature feature)` Clones the given feature.
`void`	`copyProperties(FeatureServiceFeature sourceFeature, FeatureServiceFeature targetFeature)` Copies the feature properties from the source feature to the target feature.
`void`	`exportFeatures()` start the feature export.
`Class`	`getAdditionalFieldClass(int index)` DOCUMENT ME!
`String`	`getAdditionalFieldFormula(String propertyName)` Determines the formula of the additional field with the given name.
`String[]`	`getAdditionalFieldNames()` The names of the additional fields.
`Object`	`getAdditionalFieldValue(String propertyName, FeatureServiceFeature feature)` Determines the value of the additional field with the given index for the given feature.
`TableCellEditor`	`getCellEditor(String columnName)` DOCUMENT ME!
`TableCellRenderer`	`getCellRenderer(String columnName)` DOCUMENT ME!
`Map<String,Object>`	`getDefaultValues()` Get all attribute values, which should be set, when a new object is created.
`Class<? extends FeatureServiceFeature>`	`getFeatureClass()` This method can be used to use custom feature classes with a different styling.
`FeatureCreator`	`getFeatureCreator()` Provides a creator to create new objects of the represented service.
`int`	`getIndexOfAdditionalFieldName(String name)` The index of the attribute in the attribute list of the service.
`FeatureAnnotationSymbol`	`getPointAnnotationSymbol(FeatureServiceFeature feature)` Get the point annotation symbol, that should be used, when no style is defined.
`boolean`	`hasCustomExportFeaturesMethod()` True, if the service has its own export tool.
`boolean`	`hasCustomPrintFeaturesMethod()` True, if the service has its own print tool.
`boolean`	`isCatThree()` todo: change method name
`boolean`	`isColumnEditable(String columnName)` DOCUMENT ME!
`void`	`mouseClicked(FeatureServiceFeature feature, String columnName, Object value, int clickCount)` DOCUMENT ME!
`FeatureServiceFeature[]`	`prepareFeaturesForExport(FeatureServiceFeature[] features)` DOCUMENT ME!
`boolean`	`prepareForSave(List<FeatureServiceFeature> features)` Will be invoked before the service will be saved.
`void`	`printFeatures()` start the feature print.

- Method Detail
  - afterEdit
```
Object afterEdit(FeatureServiceFeature feature,
                 String column,
                 int row,
                 Object oldValue,
                 Object newValue)
```
    This method will be invoked, after a cell was edited.
    
    Parameters:
    
    feature - the modified feature
    
    column - the modified attribute name
    
    row - the row of the feature in the model
    
    oldValue - the old attribute value
    
    newValue - the new atribute value
    
    Returns:
    
    the new value of the cell. Usually, the new value, if it was valid.
  - afterSave
```
void afterSave(TableModel model)
```
    DOCUMENT ME!
    
    Parameters:
    
    model - DOCUMENT ME!
  - beforeSave
```
void beforeSave(FeatureServiceFeature feature)
```
    Will be invoked before a the given feature will be saved.
    
    Parameters:
    
    feature - DOCUMENT ME!
  - getAdditionalFieldClass
```
Class getAdditionalFieldClass(int index)
```
    DOCUMENT ME!
    
    Parameters:
    
    index - the index of the additional field
    
    Returns:
    
    the class of the additional field with the given index
  - getAdditionalFieldNames
```
String[] getAdditionalFieldNames()
```
    The names of the additional fields. Additional fields are fields, which does not exists in the objects, but which should be automatically added.
    
    Returns:
    
    DOCUMENT ME!
  - getIndexOfAdditionalFieldName
```
int getIndexOfAdditionalFieldName(String name)
```
    The index of the attribute in the attribute list of the service. A negative value n means that the attribute should be inserted at the nth last position.
    
    Parameters:
    
    name - The name of the attribute. See getAdditionalFieldNames()
    
    Returns:
    
    The index of the attribute in the attribute list of the service or Integer.MIN_VALUE, if no additional property with the given name exists
  - getAdditionalFieldValue
```
Object getAdditionalFieldValue(String propertyName,
                               FeatureServiceFeature feature)
```
    Determines the value of the additional field with the given index for the given feature.
    
    Parameters:
    
    propertyName - the index of the additional field
    
    feature - the feature, the value should be calculated for
    
    Returns:
    
    the java.lang.Object
  - getAdditionalFieldFormula
```
String getAdditionalFieldFormula(String propertyName)
```
    Determines the formula of the additional field with the given name.
    
    Parameters:
    
    propertyName - the name of the additional field
    
    Returns:
    
    the java.lang.Object
  - getCellEditor
```
TableCellEditor getCellEditor(String columnName)
```
    DOCUMENT ME!
    
    Parameters:
    
    columnName - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getCellRenderer
```
TableCellRenderer getCellRenderer(String columnName)
```
    DOCUMENT ME!
    
    Parameters:
    
    columnName - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getFeatureCreator
```
FeatureCreator getFeatureCreator()
```
    Provides a creator to create new objects of the represented service.
    
    Returns:
    
    a creator to create new objects of the represented service
  - isColumnEditable
```
boolean isColumnEditable(String columnName)
```
    DOCUMENT ME!
    
    Parameters:
    
    columnName - DOCUMENT ME!
    
    Returns:
    
    true, if the given column should be editable
  - prepareForSave
```
boolean prepareForSave(List<FeatureServiceFeature> features)
```
    Will be invoked before the service will be saved.
    
    Parameters:
    
    features - the modified features
    
    Returns:
    
    true, if the save operation should be executed
  - mouseClicked
```
void mouseClicked(FeatureServiceFeature feature,
                  String columnName,
                  Object value,
                  int clickCount)
```
    DOCUMENT ME!
    
    Parameters:
    
    feature - DOCUMENT ME!
    
    columnName - DOCUMENT ME!
    
    value - DOCUMENT ME!
    
    clickCount - DOCUMENT ME!
  - isCatThree
```
boolean isCatThree()
```
    todo: change method name
    
    Returns:
    
    DOCUMENT ME!
  - getDefaultValues
```
Map<String,Object> getDefaultValues()
```
    Get all attribute values, which should be set, when a new object is created.
    
    Returns:
    
    A Hashmap with the attribute names and the attribute values
  - cloneFeature
```
FeatureServiceFeature cloneFeature(FeatureServiceFeature feature)
```
    Clones the given feature.
    
    Parameters:
    
    feature - the feature to clone
    
    Returns:
    
    the cloned feature
  - getPointAnnotationSymbol
```
FeatureAnnotationSymbol getPointAnnotationSymbol(FeatureServiceFeature feature)
```
    Get the point annotation symbol, that should be used, when no style is defined.
    
    Parameters:
    
    feature - the feature, that should use the point annotation symbol
    
    Returns:
    
    DOCUMENT ME!
  - hasCustomExportFeaturesMethod
```
boolean hasCustomExportFeaturesMethod()
```
    True, if the service has its own export tool.
    
    Returns:
    
    True, iff the service has its own export tool
  - exportFeatures
```
void exportFeatures()
```
    start the feature export.
  - hasCustomPrintFeaturesMethod
```
boolean hasCustomPrintFeaturesMethod()
```
    True, if the service has its own print tool.
    
    Returns:
    
    True, iff the service has its own print tool
  - printFeatures
```
void printFeatures()
```
    start the feature print.
  - copyProperties
```
void copyProperties(FeatureServiceFeature sourceFeature,
                    FeatureServiceFeature targetFeature)
```
    Copies the feature properties from the source feature to the target feature.
    
    Parameters:
    
    sourceFeature - the feature with the source values
    
    targetFeature - the values from the source feature will be copied in this feature
  - getFeatureClass
```
Class<? extends FeatureServiceFeature> getFeatureClass()
```
    This method can be used to use custom feature classes with a different styling.
    
    Returns:
    
    The class that should be used to store the features
  - prepareFeaturesForExport
```
FeatureServiceFeature[] prepareFeaturesForExport(FeatureServiceFeature[] features)
```
    DOCUMENT ME!
    
    Parameters:
    
    features - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!

Interface AttributeTableRuleSet

Method Summary

Method Detail

afterEdit

afterSave

beforeSave

getAdditionalFieldClass

getAdditionalFieldNames

getIndexOfAdditionalFieldName

getAdditionalFieldValue

getAdditionalFieldFormula

getCellEditor

getCellRenderer

getFeatureCreator

isColumnEditable

prepareForSave

mouseClicked

isCatThree

getDefaultValues

cloneFeature

getPointAnnotationSymbol

hasCustomExportFeaturesMethod

exportFeatures

hasCustomPrintFeaturesMethod

printFeatures

copyProperties

getFeatureClass

prepareFeaturesForExport