Application: gvSIG desktop » gvSIG scripting

__docformat__ = "restructuredtext en"

from org.gvsig.fmap.dal.feature.impl import DefaultFeatureStore as JFeatureStore

class FeatureStore(JFeatureStore):

  """

  Represents feature store.

  It's used as Table/Layer objects store

  Extends the `java FeatureStore`_.

  .. _`java FeatureStore` : FIXME_URL

  """

  @staticmethod

  def getSchema(self):

    """

    Returns the schema of the store.

    Its configuration of attributes.

    """

    return self.getDefaultFeatureType()

  @staticmethod

  def features(self, expresion = None, sortby="", asc=True):

    """

    Returns layer features set, with all layer features, 

    or selected featured if there are (could be empty feature set).

    :parameters:

      expresion : string

        filter to apply to the feature set to select

      sortby : string

        coma separated names of attribute to sort

      asc : boolean

        True for order ascending, False for orden descending

    :return:

      The feature set request

    :returntype:

      FeatureSet

    """   

    if expresion == None and sortby =="":

      return self.getFeatureSet()         

    try:

      application = ApplicationLocator.getManager()

      datamanager =  application.getDataManager()

      query = self.createFeatureQuery()

      if sortby != "":

          order = FeatureQueryOrder()

          order.add(sortby, asc)

          query.setOrder(order)

      if expresion != None:

          query.setFilter(datamanager.createExpresion(expresion))

      fset = self.getFeatureSet(query)

    except Exception, e:

      return None

    return fset

  @staticmethod

  def __iter__(self):

    return self.getFeatureSet()

  @staticmethod

  def __len__(self):

    return self.getFeatureSet().getSize()

  @staticmethod

  def append(self, *args, **kwargs):

    """

    Append a new feature to the store.

    If the store is not in editing mode, it is set before to append the feature.

    If one args is provided, it soul be the feature to append.

    If pairs of name,value arguments are specified, a feature is build with its,

    and is appened to the store.

    """

    try:

      if not self.isEditing():

        self.super_edit() 

      if len(args) ==1:

        values.insert(args[0])

        return

      f = self.createNewFeature()

      if f == None:

        raise RuntimeError("Failed to create a new Feature")

      for k,v in kwargs.iteritems():

        f.set(k,v)

        self.insert(f)

    except Throwable, ex:

      raise RuntimeException("Can't append values %s to layer %s (%s)" % (

        repr(kwargs), 

        self.getName(), 

        str(ex)

        )

      )

  @staticmethod

  def update(self, feature):

    """

    Updates exist feature in the store or the schema of store.

    If the store is not in editing mode, it is set before to append the feature.

    If as parameter pass a Schema, update the schema of the store. If is a feature

    update this feature.

    :parameters:

      feature : Feature 

        feature to update

    """

    if not self.isEditing():

        self.super_edit(self) 

    self.super_update(self,feature) 

  @staticmethod

  def edit(self):

    """

    Set store in edition mode.

    If the store is already in editing mode do thing.

    """     

    if not self.isEditing():

      self.super_edit()

  @staticmethod

  def commit(self):

    """

    Finish store edition saving changes. 

    If an error occurs abort transaction and raises Exception.

    """

    try:

      self.finishEditing()          

    except Throwable, ex:

      self.abort()

      raise RuntimeException("Can't finish layer edition, cancelling changes. %s" % repr(ex))

  @staticmethod

  def abort(self):

    """

    Finish store edition withoout saving changes.

    All changes are undoing.

    """

    self.cancelEditing() 

  def __call__(self):

    """

    Return the java object represented by this object.

    This method is for compatibility with scripting API of gvSIG 2.0

    :ReturnType:

      LayerVectorial

    :deprecated: 

      With gvSIG 2.1 the call this method isn't necesary

    """

    return self    

#

# Save methods edit and update that are rewriten in python

#

JFeatureStore.super_edit = JFeatureStore.edit

JFeatureStore.super_update = JFeatureStore.update

#

# Inject new methods in the class JFeatureStore

#

JFeatureStore.getSchema = FeatureStore.getSchema

JFeatureStore.features = FeatureStore.features

JFeatureStore.append = FeatureStore.append

JFeatureStore.update = FeatureStore.update

JFeatureStore.edit = FeatureStore.edit

JFeatureStore.commit = FeatureStore.commit

JFeatureStore.abort = FeatureStore.abort

JFeatureStore.__call__ = FeatureStore.__call__

JFeatureStore.__iter__ = FeatureStore.__iter__

JFeatureStore.__len__ = FeatureStore.__len__