org.gvsig.fmap.dal.feature
Interface FeatureRule

All Known Implementing Classes:

AbstractFeatureRule, FeatureRulePolygon

public interface FeatureRule

Represents a Feature validation rule. These rules are used to check Feature state integrity in editing mode.

Method Summary

boolean	checkAtFinishEditing() Returns true if this rule should be applied just when editing is being finished.
boolean	checkAtUpdate() Indicates whether this rule should be checked at update.
String	getDescription() Returns the rule description
String	getName() Returns the rule name
void	validate(Feature feature, FeatureStore featureStore) This is the method that applies this rule to the Feature, given also its associated FeatureStore.

Method Detail

getName

String getName()

Returns the rule name

Returns:

the rule name

getDescription

String getDescription()

Returns the rule description

Returns:

the rule description

validate

void validate(Feature feature,
              FeatureStore featureStore)
              throws DataException

This is the method that applies this rule to the Feature, given also its associated FeatureStore.

Parameters:

feature - Feature to which apply the rule

featureStore - FeatureStore to which the Feature belongs

Throws:

DataException - if an error occurs during validation

checkAtUpdate

boolean checkAtUpdate()

Indicates whether this rule should be checked at update.

Returns:

true if this rule should be checked at update, otherwise false.

checkAtFinishEditing

boolean checkAtFinishEditing()

Returns true if this rule should be applied just when editing is being finished.

Returns:

true if this rule should be applied when editing is being finished, otherwise false.