rtm-javatmapi 0.3.1-java

data/lib/rtm/javatmapi/aliases.rb

@@ -0,0 +1,43 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+#do not use alias in (J)RTM code
+
+module Java::OrgTmapiCore
+  module TopicMap
+    alias :tii :type_instance_index
+    alias :li :literal_index
+    alias :si :scoped_index
+
+    alias :by_ii :get_construct_by_item_identifier
+    alias :by_si :get_topic_by_subject_identifier
+    alias :by_sl :get_topic_by_subject_locator
+
+    alias :t :topics
+    alias :a :associations
+  end
+
+  module Topic
+    alias :o :occurrences
+    alias :n :names
+
+    alias :si :subject_identifiers
+    alias :add_si :add_subject_identifier 
+    alias :remove_si :remove_subject_identifier
+
+    alias :sl :subject_locators
+    alias :add_sl :add_subject_locator
+    alias :remove_sl :remove_subject_locator
+  end
+
+  module Construct
+    alias :p :parent
+    alias :ii :item_identifiers
+    alias :add_ii :add_item_identifier
+    alias :remove_ii :remove_item_identifier
+  end
+
+  module Association
+    alias :r :roles
+  end
+end

data/lib/rtm/javatmapi/core.rb

@@ -0,0 +1,16 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+require 'rtm/javatmapi/core/construct'
+require 'rtm/javatmapi/core/reifiable'
+require 'rtm/javatmapi/core/topic_map'
+require 'rtm/javatmapi/core/topic'
+require 'rtm/javatmapi/core/name'
+require 'rtm/javatmapi/core/occurrence'
+require 'rtm/javatmapi/core/association'
+require 'rtm/javatmapi/core/role'
+require 'rtm/javatmapi/core/scoped'
+require 'rtm/javatmapi/core/locator'
+require 'rtm/javatmapi/core/variant'
+require 'rtm/javatmapi/core/typed'
+require 'rtm/javatmapi/core/datatype_aware'

data/lib/rtm/javatmapi/core/association.rb

@@ -0,0 +1,71 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module Java::OrgTmapiCore::Association
+  
+  include RTM::Association
+  extend Superiseable
+  
+  superised
+  # Returns the topic map this association belongs to.
+  #
+  # :call-seq:
+  #   parent -> TopicMap
+  #
+  def parent
+  	getParent
+  end
+  alias :topic_map :parent
+  alias :reverse_children :parent
+
+  # Returns all roles parented by this association.
+  #
+  # :call-seq:
+  #   children -> Set of Roles
+  #
+  def children
+   	getRoles
+  end
+  alias :reverse_parent :children
+  
+  superised
+  # Creates a new role in this association. The optional argument 'type'
+  # specifies the role type and
+  # 'player' specifies the role player.
+  #
+  # Type and player may each be topic references.
+  #
+  # :call-seq:
+  #   create_role(type, player) -> Role
+  #
+  def create_role(type, player)
+    createRole(topic_map.get!(type),topic_map.get!(player))
+  end
+
+  superised
+  # Returns the Roles participating in this Association.
+  # The optional identifier specifies the type of
+  # the returned Roles.
+  #
+  # Identifier may be a topic reference.
+  #
+  # The result may be empty.
+  #
+  # :call-seq:
+  #   roles -> Set of Roles
+  #   roles(identifier) -> Set of Roles
+  #
+  def roles(type = :any)
+    return getRoles if type == :any
+    return java.util.HashSet.new if type == nil
+    _topic = topic_map.get(type)
+    if _topic.is_a?(Java::OrgTmapiCore::Topic)
+      return getRoles(_topic)
+    else
+      return java.util.HashSet.new
+    end
+  end
+
+
+end
+

data/lib/rtm/javatmapi/core/construct.rb

@@ -0,0 +1,92 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module Java::OrgTmapiCore::Construct
+  
+  include RTM::Construct
+  extend Superiseable
+
+  # Returns the TopicMap instance this Construct belongs to.
+  #
+  # :call-seq:
+  #   topic_map -> TopicMap
+  #
+  def topic_map
+    getTopicMap
+  end
+  
+  # Returns the parent construct this construct belongs to.
+  #
+  # :call-seq:
+  #   parent -> a construct (TopicMap, Topic, Association or Name)
+  #
+  def parent
+    getParent
+  end
+
+  # Returns true if the construct fulfills all constraints defined in the TMDM
+  def valid?
+    # This is defined in RTM::AR and we test it. I guess from the API perspective, in TMAPI the validness of an object is guaranteed.
+    true
+  end unless self.method_defined?(:valid?)
+
+
+  # Returns the item identifiers assigned to the current construct.
+  #
+  # :call-seq:
+  #   item_identifiers -> Set of Locators
+  #
+  def item_identifiers
+    getItemIdentifiers
+  end
+
+  superised
+  # Adds an item identifier to this construct.
+  # Identifier may be a String or Locator.
+  #
+  # :call-seq:
+  #   item_identifiers=(identifier)
+  #
+  def add_item_identifier(identifier)
+    # TODO Spec
+    begin
+      if identifier.is_a? Java::OrgTmapiCore::Locator
+        addItemIdentifier(identifier)
+      else
+        addItemIdentifier(topic_map.create_locator(identifier))
+      end
+    rescue Java::OrgTmapiCore::IdentityConstraintException => ice
+      # TODO add condition to switch off automerge
+      self.mergeIn(self.topic_map.get(identifier))
+    end
+  end
+  alias :item_identifiers= :add_item_identifier # FIXME ii= is not add! it's set.
+
+
+  superised
+  # Removes an item identifer from this construct,
+  # if present.
+  #
+  # Identifier may be a String or Locator.
+  #
+  # :call-seq:
+  #   remove_item_identifier(identifier)
+  #
+  def remove_item_identifier(identifier)
+    identifier = topic_map.create_locator(identifier) if identifier.is_a? String 
+    removeItemIdentifier(identifier) if identifier.is_a? Java::OrgTmapiCore::Locator
+  end
+
+  # Returns the identifier of this construct.
+  # This property has no representation in the Topic Maps - Data Model.
+  # The ID can be anything, so long as no other Construct in the
+  # same topic map has the same ID.
+  #
+  # :call_spec:
+  #   id -> String
+  #
+  def id
+    getId
+  end
+
+end

data/lib/rtm/javatmapi/core/datatype_aware.rb

@@ -0,0 +1,60 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module Java::OrgTmapiCore::DatatypeAware
+
+  include RTM::DatatypeAware
+  extend Superiseable
+
+  superised
+  # Changes the value (and if given, the datatype) of this Occurrence.
+  #
+  # The datatype must be a String or Locator.
+  #
+  # If value is a String, this methods sets the string value and
+  # the datatype implicitly to xsd:string.
+  #
+  # If argument is a Locator, this method sets the IRI value and
+  # the datatype implicitly to xsd:anyURI.
+  #
+  # If argument is a Float, this method sets the Float value and
+  # the datatype implicitly to xsd:float.
+  #
+  # If argument is a Fixnum, this method sets Fixnum value and
+  # the datatype implicitly to xsd:long.
+  #
+  # If argument is a Bignum, this method sets Bignum value and
+  # the datatype implicitly to xsd:integer.
+  #
+  # :call-seq:
+  #   value = value
+  #   value = value, datatype
+  #
+	def value=(args)
+    if args.is_a?(Array)
+      raise("value=(value) or value=(value,datatype)") unless args.size == 2
+      datatype = topic_map.create_locator(args.last)
+      value = args.first.to_s
+      if datatype.reference == RTM::PSI[:IRI]
+        setValue(topic_map.create_locator(value))
+      else
+        setValue(value, datatype)
+      end
+    else
+      setValue(args)
+    end
+  end
+
+  # Sets the datatype of this occurrence without changing its value.
+  #
+  # The datatype must be a String or Locator.
+  #
+  # :call-seq:
+  #   datatype = datatype
+  #
+  def datatype=(datatype)
+    self.value = self.value, datatype
+  end
+  alias :set_datatype :datatype=
+
+end

data/lib/rtm/javatmapi/core/locator.rb

@@ -0,0 +1,20 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module Java::OrgTmapiCore::Locator
+
+  include RTM::Locator
+  extend Superiseable
+
+  # Returns the external form of the IRI.
+  # Any special character will be escaped using the escaping conventions
+  # of RFC 3987.
+  #
+  # :call-seq:
+  #   value -> String
+  #
+  def value
+    toExternalForm
+  end
+
+end

data/lib/rtm/javatmapi/core/name.rb

@@ -0,0 +1,127 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module Java::OrgTmapiCore::Name
+
+  include RTM::Name
+  extend Superiseable
+
+  # Returns the Topic this Name belongs to.
+  #
+  # :call-seq:
+  #   parent -> Topic
+  #
+  def parent
+		getParent
+	end
+  alias :reverse_children :parent
+
+  # Returns all Variants defined for this Name.
+  #
+  # :call-seq:
+  #   children -> Array of Variants
+  #
+  def children
+   	getVariants.to_a
+  end
+  alias :reverse_parent :children
+
+  superised
+  # Returns the value of this Name.
+  #
+  # :call-seq:
+  #   value -> String
+  #
+	def value
+		getValue
+	end
+
+  # Sets the value of this name. The previous value is overridden.
+  #
+  # Argument is a String.
+  #
+  # :call-seq:
+  #   value=(argument)
+  #
+	def value=(argument)
+		setValue(argument)
+	end
+
+  superised
+  # Creates a Variant given the value and scope, if value is a Locator or
+  # given value, datatype and scope, if the value is a String.
+  #
+  # Scope may be an Array of topic references and must not be empty.
+  #
+  # Datatype may be a String or Locator.
+  #
+  # :call-seq:
+  #   create_variant(value, scope) -> Variant
+  #   create_variant(value, datatype, scope) -> Variant
+  #
+  def create_variant(value, *args)
+    # reading scope and datatype, if given
+    if args.length == 1
+      if args.first.is_a?(Hash)
+        # TODO
+      else
+        # scope given
+        scope = args.first
+        raise("create_variant(value, scope): scope must be an Array") unless scope.is_a?(Array)
+      end
+    elsif args.length == 2
+      # datatype and scope given
+      datatype = args.first
+      scope = args.last
+      raise("create_variant(value, datatype, scope): scope must be an Array") unless scope.is_a?(Array)
+    else
+      raise("create_variant: arguments don't match - no scope given.")
+    end
+    # reading the value and setting the datatype dynamicaly if not set before
+    unless datatype
+      if value.is_a?(Java::OrgTmapiCore::Locator)
+        datatype ||= RTM::PSI[:IRI]
+      elsif value.is_a?(String)
+        datatype ||= RTM::PSI[:String]
+      elsif value.is_a?(Float)
+        datatype ||= RTM::PSI[:Float]
+      elsif value.is_a?(Fixnum)
+        datatype ||= RTM::PSI[:Long]
+      elsif value.is_a?(Bignum)
+        datatype ||= RTM::PSI[:Integer]
+      elsif value.is_a?(DateTime) #DateTime is a Time and a Date
+        datatype ||= RTM::PSI[:DateTime]
+      elsif value.is_a?(Time)
+        datatype ||= RTM::PSI[:Time]
+      elsif value.is_a?(Date)
+        datatype ||= RTM::PSI[:Date]
+      else
+        raise NoDatatypeHandlerAvailableException.new(value)
+      end
+    end
+    # creating locator for datatype
+    datatype = topic_map.create_locator(datatype)
+    # value must be a String
+    value = value.to_s
+    # if datatype is xsd:anyURI -> resolve value against base_iri
+    if datatype.reference == RTM::PSI[:IRI]
+      value = topic_map.create_locator(value).reference
+    end
+    # creating an array of topics for the scope
+    scope = topic_map.get!(scope).to_java(Java::OrgTmapiCore::Topic)
+
+    begin
+      createVariant(value, datatype, scope)
+    rescue java.lang.IllegalArgumentException => iae
+      raise(iae.message)
+    end
+  end
+
+  private
+  class NoDatatypeHandlerAvailableException < Exception
+    def initialize(value)
+      super "Cannot map #{value} to a variant value+datatype. Maybe you need to add a handler for your Ruby object type."
+    end
+  end
+
+end

data/lib/rtm/javatmapi/core/occurrence.rb

@@ -0,0 +1,32 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module Java::OrgTmapiCore::Occurrence
+
+  include RTM::Occurrence
+  extend Superiseable
+
+  # Returns the Topic this Occurrence belongs to.
+  #
+  # :call-seq:
+  #   parent -> Topic
+  #
+  def parent
+		getParent
+	end
+  alias :reverse_children :parent
+
+  # Returns the lexical representation of the value of the Occurrence.
+  #
+  # For the datatype String the string itself is returned
+  # For the datatype anyURI the Locator.getReference -> String is returned.
+  #
+  # :call-seq:
+  #   value -> String
+  #
+	def value
+		getValue
+	end
+
+end
+