org.graffiti.plugins.ios.gml.attributemapping
Interface AttributeMapping

All Known Implementing Classes:
AbstractAttributeMapping, EdgeAttributeMapping, GraphAttributeMapping, GraphElementAttributeMapping, NodeAttributeMapping

public interface AttributeMapping

This interface defines a mapping from GML key paths to Gravisto attribute paths and vice versa. We have to consider whole paths in order to take into account the fact that a key may appear at different places (i.e. namespaces).

Author:
ruediger

Method Summary
 void addIgnorableGML(String gmlPath)
          Adds a GML attribute path that is ignorable when writing a GML file.
 void addIgnorableGravisto(String gravistoPath)
          Adds a Gravisto attribute path that is ignorable.
 void addMapping(String gmlPath, String gravistoPath, boolean requiresSpecialTreatment)
          Adds a mapping from a GML key path to a Gravisto attribute path indicating whether a transformation requires some extra work as opposed to just changing the path.
 String getGMLPath(String gravistoPath)
          Returns the GML key path corresponding to the given Gravisto attribute path.
 String getGravistoPath(String gmlPath)
          Returns the Gravisto attribute path corresponding to the given GML key path.
 boolean isIgnorableGML(String gmlPath)
          Returns true if the attribute at the specified GML attribute path is ignorable, false otherwise.
 boolean isIgnorableGravisto(String gravistoPath)
          Returns true if the attribute at the specified Gravisto attribute path is ignorable, false otherwise.
 boolean requiresSpecialTreatment(String gmlPath)
          Indicates whether some specific transformation work needs to be done when transforming from one representation to the other.
 

Method Detail

getGMLPath

String getGMLPath(String gravistoPath)
Returns the GML key path corresponding to the given Gravisto attribute path. If there is no mapping, null will be returned.

Parameters:
gravistoPath - the Gravisto attribute path.
Returns:
the corresponding GML key path.

getGravistoPath

String getGravistoPath(String gmlPath)
Returns the Gravisto attribute path corresponding to the given GML key path. If there is no mapping, null will be returned.

Parameters:
gmlPath - the GML key path.
Returns:
the corresponding Gravisto path.

isIgnorableGML

boolean isIgnorableGML(String gmlPath)
Returns true if the attribute at the specified GML attribute path is ignorable, false otherwise.

Parameters:
gmlPath - the GML attribute path for which to check whether the attribute is ignorable.
Returns:
true if the attribute at the specified GML attribute path is ignorable, false otherwise.

isIgnorableGravisto

boolean isIgnorableGravisto(String gravistoPath)
Returns true if the attribute at the specified Gravisto attribute path is ignorable, false otherwise.

Parameters:
gravistoPath - the Gravisto attribute path for which to check whether the attribute is ignorable.
Returns:
true if the attribute at the specified Gravisto attribute path is ignorable, false otherwise.

addIgnorableGML

void addIgnorableGML(String gmlPath)
Adds a GML attribute path that is ignorable when writing a GML file.

Parameters:
gmlPath - the GML attribute path to be added.

addIgnorableGravisto

void addIgnorableGravisto(String gravistoPath)
Adds a Gravisto attribute path that is ignorable.

Parameters:
gravistoPath - the Gravisto attribute path to be added.

addMapping

void addMapping(String gmlPath,
                String gravistoPath,
                boolean requiresSpecialTreatment)
Adds a mapping from a GML key path to a Gravisto attribute path indicating whether a transformation requires some extra work as opposed to just changing the path.

Parameters:
gmlPath - the GML key path.
gravistoPath - the Gravisto attribute path.
requiresSpecialTreatment - indicates whether special treatment is required upon a transformation.

requiresSpecialTreatment

boolean requiresSpecialTreatment(String gmlPath)
Indicates whether some specific transformation work needs to be done when transforming from one representation to the other.

Parameters:
gmlPath - the GML key path for which to check the necessity of extra work.
Returns:
true some specific transformation work needs to be done when transforming from one representation to the other, false otherwise.


Generated at 2012-05-30 11:01:25 PM CEST