mexico 0.0.9

data/lib/mexico/file_system/participant_role.rb

@@ -0,0 +1,43 @@
+# 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::ParticipantRole
+  
+  include Mexico::FileSystem::BoundToCorpus
+  extend Mexico::FileSystem::IdRef
+  
+  
+  include ::ROXML
+  
+  xml_accessor :identifier,     :from => '@identifier' 
+  xml_accessor :name,           :from => '@name' 
+  
+  xml_accessor :description, :from => "Description"     
+  
+  
+  def initialize(opts={})
+    # @corpus = corpus
+    [:identifier,:name,:description].each do |att|
+      send("#{att}=", opts[att]) if opts.has_key?(att)
+    end
+  end
+  
+end

data/lib/mexico/file_system/point_link.rb

@@ -0,0 +1,79 @@
+# 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 that targets an interval out of a scale object.
+class Mexico::FileSystem::PointLink
+  include ROXML
+
+  xml_name "PointLink"
+
+  # identifier
+  xml_accessor :identifier,        :from => '@id'
+
+  # type Float
+  xml_accessor :point, :as => Float, :from => "@point"
+
+  # 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/PointLink)
+  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 :point, %q(http://cats.sfb673.org/point)
+  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 Scale.
+  # @return (Mexico::FileSystem::Scale) 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::Scale) 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.
+  # @return (void)
+  def after_parse
+
+  end
+
+end

data/lib/mexico/file_system/property.rb

@@ -0,0 +1,35 @@
+# 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/>.
+
+# This class provides a corpus representation that is backed up by the filesystem.
+# A central Corpus definition file in the top-level folder contains an
+# XML representation of the corpus structure, and all actual resources are found
+# as files on a file system reachable from the top-level folder.
+
+class Mexico::FileSystem::Property
+
+  include ::ROXML
+  xml_name 'Property'
+
+  xml_accessor :key, :from => '@key'
+
+  xml_accessor :value, :from => :content
+
+
+end

data/lib/mexico/file_system/property_map.rb

@@ -0,0 +1,37 @@
+# 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/>.
+
+# This class provides a corpus representation that is backed up by the filesystem.
+# A central Corpus definition file in the top-level folder contains an
+# XML representation of the corpus structure, and all actual resources are found
+# as files on a file system reachable from the top-level folder.
+
+class Mexico::FileSystem::PropertyMap
+
+  include ::ROXML
+  xml_name 'PropertyMap'
+
+  xml_accessor :key, :from => '@key'
+
+  xml_accessor :properties, :as => [::Mexico::FileSystem::Property], :from => "Property"
+  xml_accessor :property_maps, :as => [::Mexico::FileSystem::PropertyMap],  :from => "PropertyMap"
+
+  attr_accessor :values
+
+end

data/lib/mexico/file_system/resource.rb

@@ -0,0 +1,174 @@
+# 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 template class doing nothing.
+class Mexico::FileSystem::Resource
+  
+  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 :media_type_id,  :from => '@media_type_id'
+
+  # type Mexico::Core::MediaType
+  collection_ref :media_type, ::Mexico::Core::MediaType, ::Mexico::Constants::MediaTypes::ALL, ::Mexico::Constants::MediaTypes::OTHER
+
+  # type Array<Mexico::FileSystem::LocalFile>
+  xml_accessor :local_files, :as => [::Mexico::FileSystem::LocalFile], :from => "LocalFile" #, :in => "."
+
+  # type Array<Mexico::FileSystem::URL>
+  xml_accessor :urls,        :as => [::Mexico::FileSystem::URL],       :from => "URL" # ,  :in => "."
+
+  # type String
+  xml_accessor :trial_id, :from => "@trial_id"
+
+  # type Mexico::FileSystem::Trial
+  id_ref :trial
+
+  # type String
+  xml_accessor :design_component_id, :from => "@design_component_id"
+
+  # type Mexico::FileSystem::DesignComponent
+  id_ref :design_component
+
+  # POSEIdON-based RDF augmentation
+  include Poseidon
+
+  self_uri %q(http://cats.sfb673.org/Resource)
+  instance_uri_scheme %q(http://phoibos.sfb673.org/corpora/#{corpus.identifier}/resources/#{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 :document, %q(http://cats.sfb673.org/document), {:value_expression => 'RDF::URI("#{self_uri}.fst")'}
+
+  rdf_include :local_files, %q(http://cats.sfb673.org/hasLocalFile)
+  rdf_include :urls, %q(http://cats.sfb673.org/hasURLs)
+
+
+  # docme
+
+  # creates a new Trial object.
+  # @option opts [String] :identifier The identifier of the new trial object.
+  # @option opts [String] :name The name of the new trial object.
+  # @option opts [String] :description The identifier of the new trial object.
+  def initialize(opts={})
+    # @corpus = corpus
+    [:identifier,:name,:description].each do |att|
+      send("#{att}=", opts[att]) if opts.has_key?(att)
+    end
+  end
+
+
+  # Indicates whether this resource is associated with a trial.
+  # @return [true,false] +true+ if this resource belongs to a trial, +false+ otherwise.
+  def linked_to_trial?
+    return trial!=nil
+  end
+
+  # Indicates whether this resource is associated with a design component.
+  # @return [true,false] +true+ if this resource belongs to a design component, +false+ otherwise.
+  def linked_to_design_component?
+    return design_component!=nil
+  end
+
+  # Returns the disk space in bytes used by all local files of this resource.
+  # @return (Integer) disk space in bytes used by all local files of this resource.
+  def complete_file_size
+    local_files.collect{ |f| f.file_size }.inject(:+)
+  end
+
+  # Indicates whether this resource is of the video media type.
+  # @return (Boolean) +true+ if this resource has media type video, +false+ otherwise.
+  def is_video?
+    return media_type==::Mexico::Constants::MediaTypes::VIDEO
+  end
+
+  # Indicates whether this resource is of the audio media type.
+  # @return (Boolean) +true+ if this resource has media type audio, +false+ otherwise.
+  def is_audio?
+    return media_type==::Mexico::Constants::MediaTypes::AUDIO
+  end
+
+  # Indicates whether this resource is of the annotation media type.
+  # @return (Boolean) +true+ if this resource has media type annotation, +false+ otherwise.
+  def is_annotation?
+    return media_type==::Mexico::Constants::MediaTypes::ANNOTATION
+  end
+
+  # Attempts to load the contents of the resource from an appropriate source into an appropriate
+  # data structure (for annotation files, into the ToE format, etc.)
+  # @return (Mexico::FileSystem::FiestaDocument) the document, or +nil+ if no document could be loaded.
+  def load
+
+    # @todo create a loader interface in a separate package
+    #       load() then takes a file or url, gets the contents as a stream,
+    #              and puts it into appropriate data structures.
+    #       choice depends on: MediaType. Whether LocalFile or URL are available.
+    #       What kinds of LF / URL are available, and which one is the newest.
+    # first goal: When document is of mediatype ANNOTATION, and there is one
+    # LocalFile, and it is of a matching type (now: ToE import), then import that
+    # one and make the resulting objects available below the resource.
+
+    # first version:
+    # if resource is annotation, and there is a toe file, then: load that toe file
+    # as a document, and define the appropriate member variable.
+
+    # puts "Is anno? %s" % is_annotation?
+    if is_annotation?
+
+      # puts "Toe File? %s" % local_files.find{ |f| f.path=~/toe$/ }
+      toe_file = local_files.find{ |f| f.path=~/toe$/ || f.path=~/fiesta$/ }
+
+      unless toe_file.nil?
+        @document = ::Mexico::FileSystem::FiestaDocument.open(toe_file.absolute_path)
+        @document.resource = self
+        return @document
+      end
+    end
+  end
+
+  # Returns the annotation document previously loaded in {#load} (this is only the case
+  # if resource has media type video, and if an appropriate local file is present).
+  # @return (Mexico::FileSystem::FiestaDocument) the document, or +nil+ if no document has been loaded.
+  def document
+   defined?(@document) ? @document : nil
+  end
+
+  # This method performs additional linking and cleanup after parsing a XML representation.
+  def after_parse
+    # puts "Parsed Resource #{self.identifier}"
+  end
+
+  # @todo Resource must, upon creation, be bound to a physical resource somewhere in the file system.
+
+end

data/lib/mexico/file_system/scale.rb

@@ -0,0 +1,125 @@
+# 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 generic scale.
+class Mexico::FileSystem::Scale
+
+  DIM_TIME = 'time'
+  DIM_SPACE = 'space'
+  DIM_OTHER = 'other'
+
+  include ::ROXML
+  xml_name 'Scale'
+
+  xml_accessor :identifier, :from => '@id'
+  xml_accessor :name,       :from => '@name'
+
+  xml_accessor :unit, :from => '@unit'
+  xml_accessor :dimension, :from => '@dimension'
+  xml_accessor :role, :from => '@role'
+  xml_accessor :continuous?, :from => '@continuous'
+
+  xml_accessor :mode, :from => '@mode'
+
+  attr_accessor :document
+
+  # POSEIdON-based RDF augmentation
+  include Poseidon
+  self_uri %q(http://cats.sfb673.org/Scale)
+  instance_uri_scheme 'http://phoibos.sfb673.org/resources/1##{identifier}' # %q(#{document.self_uri}##{identifier})
+  rdf_property :identifier, %q(http://cats.sfb673.org/identifier)
+  rdf_property :name, %q(http://cats.sfb673.org/name)
+
+  rdf_property :unit, %q(http://cats.sfb673.org/unit)
+  rdf_property :dimension, %q(http://cats.sfb673.org/dimension)
+  rdf_property :role, %q(http://cats.sfb673.org/role)
+  rdf_property :continuous?, %q(http://cats.sfb673.org/is_continuous)
+  rdf_property :mode, %q(http://cats.sfb673.org/mode)
+
+
+  # static collection of MODES
+  # mode : MODES collection
+  # @todo collection of scale elements (if not continuous)
+
+  # OKunit : SI units or custom units
+  # OK dimension : String (x,y,z,t, etc.)
+  # OK role : String (free text)
+  # continuous? : Boolean
+
+  def initialize(args={})
+    args.each do |k,v|
+      if self.respond_to?("#{k}=")
+        send("#{k}=", v)
+      end
+    end
+  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
+
+  # Creates an RDF representation in Turtle notation for this class.
+  # @return [String] An RDF representation in Turtle notation for this class.
+  def self.to_turtle
+    rdf_writer = RDF::Turtle::Writer
+    return rdf_writer.buffer(:base_uri => 'http://phoibos.sfb673.org/',
+                             :prefixes => {
+                                 :cats => 'http://cats.sfb673.org/',
+                                 :rdfs => RDF::RDFS.to_uri,
+                                 :foaf => RDF::FOAF.to_uri,
+                                 :dc => RDF::DC.to_uri,
+                                 :owl => RDF::OWL.to_uri,
+                                 :xsd  => RDF::XSD.to_uri} #
+    ) do |writer|
+      as_rdf.each_statement do |statement|
+        writer << statement
+      end
+    end
+  end
+
+  # Creates an RDF representation in Turtle notation for this object.
+  # @return [String] An RDF representation in Turtle notation for this object.
+  def to_turtle
+    rdf_writer = RDF::Turtle::Writer
+    return rdf_writer.buffer(:base_uri => 'http://phoibos.sfb673.org/',
+                             :prefixes => {
+                                 :cats => 'http://cats.sfb673.org/',
+                                 :rdfs => RDF::RDFS.to_uri,
+                                 :foaf => RDF::FOAF.to_uri,
+                                 :dc => RDF::DC.to_uri,
+                                 :owl => RDF::OWL.to_uri,
+                                 :xsd  => RDF::XSD.to_uri} #
+    ) do |writer|
+      as_rdf.each_statement do |statement|
+        writer << statement
+      end
+    end
+  end
+
+  def is_timeline?
+    self.dimension == DIM_TIME
+  end
+
+  def is_spatial_axis?
+    self.dimension == DIM_SPACE
+  end
+
+end

data/lib/mexico/file_system/section.rb

@@ -0,0 +1,41 @@
+# 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/>.
+
+# This class provides a corpus representation that is backed up by the filesystem.
+# A central Corpus definition file in the top-level folder contains an
+# XML representation of the corpus structure, and all actual resources are found
+# as files on a file system reachable from the top-level folder.
+
+class Mexico::FileSystem::Section
+
+  LIFECYCLE = 'lifecycle'
+
+  VOCABULARIES = 'vocabularies'
+
+  include ::ROXML
+  xml_name 'Section'
+
+  xml_accessor :key, :from => '@key'
+
+  xml_accessor :properties,    :as => [::Mexico::FileSystem::Property],     :from => "Property"
+  xml_accessor :property_maps, :as => [::Mexico::FileSystem::PropertyMap],  :from => "PropertyMap"
+
+
+
+end

data/lib/mexico/file_system/static_collection_ref.rb

@@ -0,0 +1,64 @@
+# 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 +IdRef+ module provides a simple mechanism to map IDREF attributes
+# in an XML document to Ruby objects that are stored elsewhere in the
+# object tree. They are retrieved and accessed via the central corpus
+# object.
+module Mexico::FileSystem::StaticCollectionRef
+
+  # Defines a foreign key reference for an object. By default, it will
+  # refer to the corresponding collection in the top-level corpus, and
+  # it will retrieve the object via its +identifier+ field.
+  def collection_ref(field_identifier, field_class, field_collection, default)
+    
+    field_name = field_identifier.to_s
+    pluralized_field_name = "#{field_name}s"
+    field_name_id = "#{field_name}_id"
+    
+    define_method field_name do
+      if instance_variable_get("@#{field_name}").nil?
+        self.send("#{field_name}=", instance_variable_get("@#{field_name_id}"))
+        # self.instance_variable_set("@#{field_name}", instance_variable_get("@#{field_name_id}"))
+      end
+      return instance_variable_get("@#{field_name}")
+    end
+    
+    define_method "#{field_name}=" do |param|
+      #instance_variable_set("@#{field_name_id}", param.identifier)
+      #instance_variable_set("@#{field_name}", param)
+
+      if param.nil?
+        instance_variable_set "@#{field_name}", default # Mexico::Constants::MediaTypes::OTHER
+      elsif param.kind_of?(String)
+        #@media_type = Mexico::Constants::MediaTypes::ALL.find{|m| m.identifier==new_media_type.to_s}
+        instance_variable_set "@#{field_name}", field_collection.find{|i| i.identifier==param.to_s}
+        if instance_variable_get("@#{field_name}").blank?
+          instance_variable_set "@#{field_name}", default
+        end
+      elsif param.kind_of?(field_class)
+        instance_variable_set "@#{field_name}", param
+      end
+      @media_type_id = @media_type.identifier
+      instance_variable_set "@#{field_name_id}", instance_variable_get("@#{field_name}").identifier
+      return instance_variable_get("@#{field_name}")
+    end
+    
+  end
+  
+end

data/lib/mexico/file_system/template.rb

@@ -0,0 +1,23 @@
+# 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 template class doing nothing.
+class Mexico::FileSystem::Template
+  
+  
+end