mexico 0.0.9

data/lib/mexico/file_system/item.rb

@@ -0,0 +1,166 @@
+# This file is part of the MExiCo gem.
+# Copyright (c) 2012-2014 Peter Menke, SFB 673, Universität Bielefeld
+# http://www.sfb673.org
+#
+# MExiCo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of
+# the License, or (at your option) any later version.
+#
+# MExiCo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with MExiCo. If not, see
+# <http://www.gnu.org/licenses/>.
+
+# The basic data unit object.
+class Mexico::FileSystem::Item
+
+  include ::ROXML
+  xml_name 'I'
+
+  xml_accessor :identifier, :from => '@id'
+
+  # @todo compound links (later)
+
+  # collection of Mexico::FileSystem::ItemLink
+  xml_accessor :explicit_item_links, :as => [Mexico::FileSystem::ItemLink],     :from => "ItemLink",     :in => "Links"
+
+  # collection of Mexico::FileSystem::LayerLink
+  xml_accessor :layer_links,    :as => [Mexico::FileSystem::LayerLink],    :from => "LayerLink",    :in => "Links"
+
+  # collection of Mexico::FileSystem::PointLink
+  xml_accessor :point_links,    :as => [Mexico::FileSystem::PointLink],    :from => "PointLink",    :in => "Links"
+
+  # collection of Mexico::FileSystem::IntervalLink
+  xml_accessor :interval_links, :as => [Mexico::FileSystem::IntervalLink], :from => "IntervalLink", :in => "Links"
+
+  # collection of Mexico::FileSystem::Data
+  xml_accessor :data, :as => Mexico::FileSystem::Data, :from => "Data"
+
+  attr_accessor :document
+
+  attr_accessor :implicit_item_links
+
+  # POSEIdON-based RDF augmentation
+  include Poseidon
+  self_uri %q(http://cats.sfb673.org/Item)
+  instance_uri_scheme %q(#{document.self_uri}##{identifier})
+  rdf_property :identifier, %q(http://cats.sfb673.org/identifier)
+  rdf_property :name, %q(http://cats.sfb673.org/name)
+
+  rdf_include :layer_links, %q(http://cats.sfb673.org/hasLayerLink)
+  rdf_include :item_links, %q(http://cats.sfb673.org/hasItemLink)
+  rdf_include :point_links, %q(http://cats.sfb673.org/hasPointLink)
+  rdf_include :interval_links, %q(http://cats.sfb673.org/hasIntervalLink)
+  rdf_include :data, %q(http://cats.sfb673.org/hasData)
+
+  def initialize(args={})
+    args.each do |k,v|
+      if self.respond_to?("#{k}=")
+        send("#{k}=", v)
+      end
+    end
+    @explicit_item_links = []
+    @implicit_item_links = []
+    @inverse_linked_items = []
+    @layer_links = []
+    @point_links = []
+    @interval_links = []
+  end
+
+  # This method attempts to link objects from other locations of the XML/object tree
+  # into position inside this object, by following the xml ids given in the
+  # appropriate fields of this class.
+  def after_parse
+    # store self
+    ::Mexico::FileSystem::FiestaDocument.store(self.identifier, self)
+
+    [item_links,layer_links,point_links,interval_links].flatten.each do |link|
+      link.item = self
+
+      if ::Mexico::FileSystem::FiestaDocument.knows?(link.target)
+        link.target_object=::Mexico::FileSystem::FiestaDocument.resolve(link.target)
+      else
+        # store i in watch list
+        ::Mexico::FileSystem::FiestaDocument.watch(link.target, link, :target_object=)
+      end
+
+    end
+
+  end
+
+  def item_links
+    @explicit_item_links + @implicit_item_links
+  end
+
+  def add_inverse_linked_item(item)
+    @inverse_linked_items << item
+  end
+
+  def add_item_link(new_item_link)
+    # add the item link
+    add_explicit_item_link(new_item_link)
+
+    other_item = new_item_link.target_item
+
+    # add an inverse item link for _every_ item link
+    # this is for retrieving item links from the other direction
+    other_item.add_inverse_linked_item(self)
+
+    # if an inverse relation for the role exists,
+    # puts Mexico::FileSystem::ItemLink::INVERSE_ROLES.has_key?(new_item_link.role)
+    if Mexico::FileSystem::ItemLink::INVERSE_ROLES.has_key?(new_item_link.role)
+      # add an implicit link for this inverse relation
+      # puts new_item_link.target_item
+
+      other_item.add_implicit_item_link Mexico::FileSystem::ImplicitItemLink.new(
+                                            role: Mexico::FileSystem::ItemLink::INVERSE_ROLES[new_item_link.role],
+                                            target_object: self, item: other_item )
+    end
+  end
+
+  def add_explicit_item_link(new_item_link)
+    @explicit_item_links << new_item_link
+  end
+
+  def add_implicit_item_link(new_item_link)
+    @implicit_item_links << new_item_link
+  end
+
+  def add_point_link(new_point_link)
+    @point_links << new_point_link
+  end
+
+
+  def add_interval_link(new_interval_link)
+    @interval_links << new_interval_link
+  end
+
+
+  def add_layer_link(new_layer_link)
+    @layer_links << new_layer_link
+  end
+
+  def layers
+    #puts layer_links.collect{|l| l.target}.join
+    #puts layer_links.collect{|l| l.target.class }.join
+    layer_links.collect{|l| l.layer }
+  end
+
+  # Retrieves all items that act as a source (or predecessor)
+  # in the item link graph.
+  def sources
+    @inverse_linked_items
+  end
+
+  # Retrieves all items that act as a target (or successor)
+  # in the item link graph.
+  def targets
+    item_links.collect{|l| l.target_object }
+  end
+
+end

data/lib/mexico/file_system/item_link.rb

@@ -0,0 +1,98 @@
+# This file is part of the MExiCo gem.
+# Copyright (c) 2012-2014 Peter Menke, SFB 673, Universität Bielefeld
+# http://www.sfb673.org
+#
+# MExiCo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of
+# the License, or (at your option) any later version.
+#
+# MExiCo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with MExiCo. If not, see
+# <http://www.gnu.org/licenses/>.
+
+# A link from an item to a layer.
+class Mexico::FileSystem::ItemLink
+
+  ROLE_PARENT = 'parent'
+  ROLE_CHILD = 'child'
+  ROLE_PREDECESSOR = 'predecessor'
+  ROLE_SUCCESSOR = 'successor'
+
+  INVERSE_ROLES = {
+      ROLE_PARENT => ROLE_CHILD,
+      ROLE_CHILD => ROLE_PARENT,
+      ROLE_PREDECESSOR => ROLE_SUCCESSOR,
+      ROLE_SUCCESSOR => ROLE_PREDECESSOR
+  }
+
+  include ::ROXML
+  xml_name 'ItemLink'
+
+  # identifier
+  xml_accessor :identifier, :from => '@id'
+
+  # type String
+  xml_accessor :role, :from => '@role'
+
+  # type String
+  xml_accessor :target, :from => "@target"
+
+  attr_accessor :item
+  attr_accessor :document
+
+  # POSEIdON-based RDF augmentation
+  include Poseidon
+  self_uri %q(http://cats.sfb673.org/ItemLink)
+  instance_uri_scheme %q(#{document.self_uri}##{identifier})
+  rdf_property :identifier, %q(http://cats.sfb673.org/identifier)
+  rdf_property :role, %q(http://cats.sfb673.org/role)
+  rdf_property :target, %q(http://cats.sfb673.org/target), :value_expression => 'RDF::URI(target_object.self_uri)'
+
+  def initialize(args={})
+    args.each do |k,v|
+      if self.respond_to?("#{k}=")
+        send("#{k}=", v)
+      end
+    end
+  end
+
+  # returns the target object, in this case, an Item.
+  # @return (Mexico::FileSystem::Item) the scale this interval link points to.
+  def target_object
+    @target_object
+  end
+
+  # Sets a new target object (and updates the corresponding identifier)
+  # @param (Mexico::FileSystem::Item) new_target The new target object to set
+  # @return (void)
+  def target_object=(new_target)
+    # puts "SETTING target object to %s, %s" % [new_target.identifier, new_target]
+    @target_object=new_target
+    @target=target_object.identifier
+  end
+
+  # This method attempts to link objects from other locations of the XML/object tree
+  # into position inside this object, by following the xml ids given in the
+  # appropriate fields of this class.
+  def after_parse
+    # puts "item link after parse. What is the situation?"
+    #
+    # if ::Mexico::FileSystem::FiestaDocument.knows?(target)
+    #   puts "  store knows the needed target. fetch it and set it."
+    #   @target_object=::Mexico::FileSystem::FiestaDocument.resolve(target)
+    #   puts "    %s" % @target_object
+    # else
+    #   # store i in watch list
+    #   ::Mexico::FileSystem::FiestaDocument.watch(target, item, :target_object=)
+    # end
+  end
+
+  alias_method :target_item, :target_object
+
+end

data/lib/mexico/file_system/item_links_proxy.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+class Mexico::FileSystem::ItemLinksProxy < Array
+
+  def initialize(parent_item)
+    @item = parent_item
+  end
+
+  def <<(item_link)
+    @item.add_item_link(item_link)
+  end
+
+end

data/lib/mexico/file_system/layer.rb

@@ -0,0 +1,89 @@
+# This file is part of the MExiCo gem.
+# Copyright (c) 2012-2014 Peter Menke, SFB 673, Universität Bielefeld
+# http://www.sfb673.org
+#
+# MExiCo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of
+# the License, or (at your option) any later version.
+#
+# MExiCo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with MExiCo. If not, see
+# <http://www.gnu.org/licenses/>.
+
+# A layer (or tier) in an transcription or annotation document.
+class ::Mexico::FileSystem::Layer
+
+  include ROXML
+
+  xml_accessor :identifier, :from => '@id'
+  xml_accessor :name,       :from => '@name'
+
+  attr_accessor :document
+
+  # POSEIdON-based RDF augmentation
+  include Poseidon
+  self_uri %q(http://cats.sfb673.org/Layer)
+  instance_uri_scheme %q(#{document.self_uri}##{identifier})
+  rdf_property :identifier, %q(http://cats.sfb673.org/identifier)
+  rdf_property :name, %q(http://cats.sfb673.org/name)
+
+
+  # data type
+  # content structure
+
+  def initialize(args={})
+    args.each do |k,v|
+      if self.respond_to?("#{k}=")
+        send("#{k}=", v)
+      end
+    end
+  end
+
+  def items
+    @document.items.select{|i| i.layers.include?(self) }
+  end
+
+  # overrides method in ROXML
+  # callback after xml parsing process, to store this element in the
+  # document cache.
+  def after_parse
+    ::Mexico::FileSystem::FiestaDocument.store(self.identifier, self)
+  end
+
+  # returns all layers that are linked to this layer such that this layer
+  # is the target, and the result layer is the source.
+  def predecessor_layers
+    document.layer_connectors.select{|c| c.target==self}.collect{|c| [c.source, c.role]}
+  end
+
+  # returns all layers that are linked to this layer such that this layer
+  # is the source, and the result layer is the target.
+  def successor_layers
+    document.layer_connectors.select{|c| c.source==self}.collect{|c| [c.target, c.role]}
+  end
+
+  def items_form_a_forest?
+
+    # I need precise semantics what kinds of item links
+    # are supposed to model an actual parent-child-relationship.
+    self.items.each do |item|
+      puts "sources size for items %s: %i" % [item.identifier, item.sources.size]
+      return false if item.sources.size > 1
+    end
+    return true
+  end
+
+  def items_form_an_edgeless_graph?
+    self.items.each do |item|
+      return false if item.item_links.size > 1
+    end
+  end
+
+
+end

data/lib/mexico/file_system/layer_connector.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+# This file is part of the MExiCo gem.
+# Copyright (c) 2012-2014 Peter Menke, SFB 673, Universität Bielefeld
+# http://www.sfb673.org
+#
+# MExiCo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of
+# the License, or (at your option) any later version.
+#
+# MExiCo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with MExiCo. If not, see
+# <http://www.gnu.org/licenses/>.
+
+# A typed connector between two layers (or tiers) in an transcription or annotation document.
+class Mexico::FileSystem::LayerConnector
+
+  include ROXML
+
+  xml_accessor :identifier, :from => '@id'
+  xml_accessor :name,       :from => '@name'
+
+  xml_accessor :source_id, :from => '@source'
+  xml_accessor :target_id, :from => '@target'
+
+  xml_accessor :role, :from => '@role'
+
+  attr_accessor :document
+
+
+  def initialize(new_source, new_target, args={})
+    self.source= new_source
+    self.target= new_target
+    args.each do |k,v|
+      if self.respond_to?("#{k}=")
+        send("#{k}=", v)
+      end
+    end
+  end
+
+  # Retrieves the source layer for this layer connector.
+  # @return [Layer] The source layer.
+  def source
+    @source
+  end
+
+  # Sets a new source layer for this layer connector.
+  # @param new_source_layer [Layer] The layer to be set as the new source.
+  # @return [void]
+  def source=(new_source_layer)
+    @source = new_source_layer
+    @source_id = @source.identifier
+  end
+
+  # Retrieves the target layer for this layer connector.
+  # @return [Layer] The target layer.
+  def target
+    @target
+  end
+
+  # Sets a new target layer for this layer connector.
+  # @param new_target_layer [Layer] The layer to be set as the new target.
+  # @return [void]
+  def target=(new_target_layer)
+    @target = new_target_layer
+    @target_id = @target.identifier
+  end
+
+end

data/lib/mexico/file_system/layer_link.rb

@@ -0,0 +1,75 @@
+# This file is part of the MExiCo gem.
+# Copyright (c) 2012-2014 Peter Menke, SFB 673, Universität Bielefeld
+# http://www.sfb673.org
+#
+# MExiCo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of
+# the License, or (at your option) any later version.
+#
+# MExiCo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with MExiCo. If not, see
+# <http://www.gnu.org/licenses/>.
+
+# A link from an item to a layer.
+class Mexico::FileSystem::LayerLink
+
+  include ::ROXML
+  xml_name 'LayerLink'
+
+  # identifier
+  xml_accessor :identifier,        :from => '@id'
+
+  xml_accessor :role, :from => '@role'
+
+  xml_accessor :target, :from => "@target"
+
+  attr_accessor :item
+  attr_accessor :document
+
+  # POSEIdON-based RDF augmentation
+  include Poseidon
+  self_uri %q(http://cats.sfb673.org/LayerLink)
+  instance_uri_scheme %q(#{document.self_uri}##{identifier})
+  rdf_property :identifier, %q(http://cats.sfb673.org/identifier)
+  rdf_property :role, %q(http://cats.sfb673.org/role)
+  rdf_property :target, %q(http://cats.sfb673.org/target), :value_expression => 'RDF::URI(target_object.self_uri)'
+
+
+  def initialize(args={})
+    args.each do |k,v|
+      if self.respond_to?("#{k}=")
+        send("#{k}=", v)
+      end
+    end
+  end
+
+  # returns the target object, in this case, a Layer.
+  # @return (Mexico::FileSystem::Layer) the scale this interval link points to.
+  def target_object
+    @target_object
+  end
+
+  # Sets a new target object (and updates the corresponding identifier)
+  # @param (Mexico::FileSystem::Layer) new_target The new target object to set
+  # @return (void)
+  def target_object=(new_target)
+    @target_object=new_target
+    @target=@target_object.identifier
+  end
+
+  # This method attempts to link objects from other locations of the XML/object tree
+  # into position inside this object, by following the xml ids given in the
+  # appropriate fields of this class.
+  def after_parse
+
+  end
+
+  alias_method :layer, :target_object
+
+end

data/lib/mexico/file_system/local_file.rb

@@ -0,0 +1,101 @@
+# This file is part of the MExiCo gem.
+# Copyright (c) 2012-2014 Peter Menke, SFB 673, Universität Bielefeld
+# http://www.sfb673.org
+#
+# MExiCo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of
+# the License, or (at your option) any later version.
+#
+# MExiCo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with MExiCo. If not, see
+# <http://www.gnu.org/licenses/>.
+
+require 'poseidon'
+
+# A LocalFile object represents a file on a local file system, with additional
+# information
+class Mexico::FileSystem::LocalFile
+  
+  include Mexico::FileSystem::BoundToCorpus
+  extend Mexico::FileSystem::IdRef
+  extend Mexico::FileSystem::StaticCollectionRef
+  
+  include ::ROXML
+
+  # identifier
+  xml_accessor :identifier,     :from => '@identifier' 
+
+  # type String
+  xml_accessor :name,           :from => '@name'
+
+  # type String
+  xml_accessor :description,    :from => 'Description'
+
+  # type String
+  xml_accessor :path, :from => "@path"
+
+
+  # POSEIdON-based RDF augmentation
+  include Poseidon
+  self_uri %q(http://cats.sfb673.org/LocalFile)
+  instance_uri_scheme %q(http://phoibos.sfb673.org/corpora/#{corpus.identifier}/local_files/#{identifier})
+  rdf_property :identifier, %q(http://cats.sfb673.org/identifier)
+  rdf_property :name, %q(http://cats.sfb673.org/name)
+  rdf_property :description, %q(http://cats.sfb673.org/description)
+  rdf_property :path, %q(http://cats.sfb673.org/path)
+
+
+  # Creates a new local file object.
+  # @option opts [String] :identifier The identifier of the new design (required).
+  # @option opts [String] :name The name of the new design. (required).
+  # @option opts [String] :description A description of the new design (optional).
+  def initialize(opts={})
+    [:identifier,:name,:description].each do |att|
+      send("#{att}=", opts[att]) if opts.has_key?(att)
+    end
+  end
+
+  # Resolves any relative path given in the path field, and returns an absolute
+  # path suited for the current operating system.
+  # @return (String) a string containing the absolute path to the file.
+  def absolute_path
+    if path.starts_with? "."
+      return File.expand_path(File.join(@corpus.base_path, path))
+    end
+    return path
+  end
+
+  # Indicates whether the file described at the path actually exists.
+  # @return (Boolean) +true+ if the described file exists, +false+ otherwise.
+  def file_exists?
+    return false if path.blank?
+    File.exists?(absolute_path)
+  end
+
+  # Returns a file object for this {LocalFile} object.
+  # @return (File) a file object for the described file, or +nil+ if there is no readable file at that location.
+  def file_handle
+    return nil if path.blank?
+    return File.open(absolute_path)
+  end
+
+  # Returns the size of the file (in bytes).
+  # @return (Integer) the size of the file in bytes, or +nil+ if no file can be found.
+  def file_size
+    return nil if path.blank?
+    return File.size(absolute_path)
+  end
+
+
+  # This method performs additional linking and cleanup after parsing a XML representation.
+  def after_parse
+    # puts "Parsed LocalFile"
+  end
+
+end

data/lib/mexico/file_system/participant.rb

@@ -0,0 +1,69 @@
+# This file is part of the MExiCo gem.
+# Copyright (c) 2012-2014 Peter Menke, SFB 673, Universität Bielefeld
+# http://www.sfb673.org
+#
+# MExiCo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of
+# the License, or (at your option) any later version.
+#
+# MExiCo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with MExiCo. If not, see
+# <http://www.gnu.org/licenses/>.
+
+# Participant Roles describe the nature of the associated participant:
+# Possible values are, e.g., naive participants, confederates, 
+# experimenters, etc.
+class Mexico::FileSystem::Participant
+  
+  include Mexico::FileSystem::BoundToCorpus
+  extend Mexico::FileSystem::IdRef
+  
+  include ::ROXML
+  
+  xml_accessor :identifier,          :from => '@identifier' 
+  xml_accessor :name,                :from => '@name' 
+  xml_accessor :participant_role_id, :from => '@participant_role_id' 
+  
+  xml_accessor :description, :from => "Description"     
+  
+
+  # def participant_role
+  #   ::Mexico::Constants::ParticipantRoles.get(participant_role_id)
+  # end
+  
+  # def participant_role=(new_participant_role)
+  #   # check whether param is a string or a participant role object
+  #   if new_participant_role.kind_of?(String)
+  #     new_object = ::Mexico::Constants::ParticipantRoles.get(new_participant_role)
+  #     @participant_role_id=new_participant_role
+  #   end
+  #   if new_participant_role.kind_of?(::Mexico::FileSystem::ParticipantRole)
+  #     unless ::Mexico::Constants::ParticipantRoles.has?(new_participant_role.identifier)
+  #       # raise exception, this pr isn't available
+  #     else
+  #       participant_role_id = new_participant_role.identifier
+  #     end
+  #   end
+  # end
+  
+  # Creates a new participant object.
+  # @option opts [String] :identifier The identifier of the new participant object.
+  # @option opts [String] :name The name of the new participant object.
+  # @option opts [String] :description The identifier of the new participant object.
+  # @option opts [String] :identifier The identifier of the new participant object.
+  # @option opts [String] :name The name of the new participant object.
+  # @option opts [String] :participant_role The participant role of the new participant object.
+  def initialize(opts={})
+    # @corpus = corpus
+    [:identifier,:name,:description,:participant_role].each do |att|
+      send("#{att}=", opts[att]) if opts.has_key?(att)
+    end
+  end
+  
+end