Application: gvSIG desktop » gvSIG scripting

from org.gvsig.fmap.dal.feature.impl import DefaultFeatureType as JSchema

from org.gvsig.fmap.dal.feature.impl import DefaultEditableFeatureType as JEditableSchema

from org.gvsig.fmap.dal import DataTypes

from org.gvsig.app import ApplicationLocator

class Schema(JSchema):

  """

  Stores the definition of the attributes of a feature store.

  This definition es read-only. If need to modify get a editable

  copy of this with getEditable.

  Extends the `java FeatureType`_ class.

  .. _`java FeatureType` : FIXME_URL  

  """

  @staticmethod

  def __getitem__(self, name):

    return self.getAttributeDescriptor(name)

  @staticmethod

  def __iter__(self):

    return iter(self.getAttributeDescriptors())

  @staticmethod

  def __len__(self):

    return len(self.getAttributeDescriptors())

  @staticmethod

  def get(self, name, default=None):

    """

    Returns a feature attribute descriptor that contains information about 

    one feature attribute, such as its name, data type or precision. 

    :parameters:

      name : string

        name of the attribute of the feature

      default : object

        default value to return when no attribute of name exists in the feature. 

        Default value is None.

    :return:

      The FeatureAttributeDescriptor requested

    :returntype:

      FeatureAttributeDescriptor_

    .. _FeatureAttributeDescriptor : FIXME_URL    

    """

    x = self.getAttributeDescriptor(name)

    if x == None:

      return default

    return x

  @staticmethod

  def getAttrNames(self):

    """

    Returns a list with name of attributes in the schema

    :return:

      The names of the attributes

    :returntype:

      string

    """

    if not self.getAttributeDescriptors():

      return None

    return [attr.getName() for attr in self.getAttributeDescriptors()]

  @staticmethod

  def __call__(self):

    """

    Return the java object represented by this object.

    This method is for compatibility with scripting API of gvSIG 2.0

    :ReturnType:

      Schema

    :deprecated: 

      With gvSIG 2.1 the call this method isn't necesary

    """

    return self    

class EditableSchema(JEditableSchema):

  """

  Stores the definition of the attributes of a feature store.

  This is an editable definition of the schema.

  Extends the `java EditableFeatureType`_ class.

  .. _`java EditableFeatureType` : FIXME_URL  

  """

  @staticmethod

  def append(self, name, type, size=None, default=None, precision=4):

    """

    Adds a new attribute to the feature definition.

    :parameters:

      name : string

        name of the new attribute

      type : int, string, DataType_

        the type of the new attribute

      size : int

        if the attribute is a string, length of this

      default : object

        default value for the new attribute

      precision : int

        the precision for types double and float.

    :return:

      the new FeatureAttributeDescriptor

    :returntype:

      EditableFeatureAttributeDescriptor_

    .. _EditableFeatureAttributeDescriptor : FIXME_URL    

    .. _DataType : FIXME_URL

    """

    application = ApplicationLocator.getManager()

    datamanager =  application.getDataManager()

    dataTypes = application.getDataTypesManager()

    if isinstance(type, str):

      try:

        type = dataTypes.getType(type) # dataType constant value from string

        type = dataTypes.get(type)

      except:

        raise RuntimeError(

            "Feature Property Data type (%s) is not valid.  name=%s, type=%s, size=%s, default=%s)" % (

                type, 

                name, 

                type, 

                size, 

                default

            )

        )

    elif isinstance(type, int):

      try:

        type = dataTypes.get(type)

      except:

        raise RuntimeError(

            "Data type (%s) is not valid.  name=%s, type=%s, size=%s, default=%s)" % (

                type, 

                name, 

                type, 

                size, 

                default

            )

        )

    elif !isinstance(type,DataType):

        raise RuntimeError(

            "Data type (%s) is not valid.  name=%s, type=%s, size=%s, default=%s)" % (

                type, 

                name, 

                type, 

                size, 

                default

            )

        )

    attribute = self.add(name, type.getType())

    if size != None: 

      attribute.setSize(size)

    if default != None:

      attribute.setDefaultValue(default)

    if precision != None and type.getType() in (DataTypes.DOUBLE, DataTypes.FLOAT):

      attribute.setPrecision(precision)

    if type.getType() == DataTypes.GEOMETRY and self.getDefaultGeometryAttributeName()==None:

      self.setDefaultGeometryAttributeName(name)

    return attribute

  @staticmethod

  def __call__(self):

    """

    Return the java object represented by this object.

    This method is for compatibility with scripting API of gvSIG 2.0

    :ReturnType:

      EditableSchema

    :deprecated: 

      With gvSIG 2.1 the call this method isn't necesary

    """

    return self    

#

# Inject new methods in the class JSchema

#

JSchema.__call__ = Schema.__call__

JSchema.__iter__ = Schema.__iter__

JSchema.__len__ = Schema.__len__

JSchema.get = Schema.get

JSchema.getAttrNames = Schema.getAttrNames

#

# Inject new methods in the class JSchema

#

JEditableSchema.__call__ = EditableSchema.__call__

JEditableSchema.__iter__ = EditableSchema.__iter__

JEditableSchema.__len__ = EditableSchema.__len__

JEditableSchema.get = EditableSchema.get

JEditableSchema.getAttrNames = EditableSchema.getAttrNames

JEditableSchema.append = EditableSchema.append