rtm-javatmapi 0.2.0

data/lib/rtm/javatmapi/base.rb

@@ -0,0 +1,30 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module RTM
+
+  def self.connect
+    @@tmsf = TopicMapSystemFactory.newInstance.newTopicMapSystem
+  end
+
+  def self.create(base_locator)
+    @@tmsf.createTopicMap(base_locator)
+  end
+
+
+  def self.[](*args)
+    if args.size == 0
+      return @@tmsf.getLocators.map {|l| @@tmsf.getTopicMap l}
+    end
+    args.map{|l| @@tmsf.getTopicMap l }
+  end
+
+  # Applications SHOULD call this method when the RTM is no longer required
+  def self.close
+    if defined?(@@tmsf) && @@tmsf.nil?
+      @@tmsf.close
+      @@tmsf = nil
+    end
+  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/topic_map_system'
+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'

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
+  
+  extend Superiseable
+  #include RTM::Association
+  
+  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 or 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,68 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module Java::OrgTmapiCore::Construct
+  
+  extend Superiseable
+  #include RTM::Construct
+
+  # Returns the TopicMap instance this Construct belongs to.
+  #
+  # :call-seq:
+  #   topic_map -> TopicMap
+  #
+  def topic_map
+    getTopicMap
+  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?)
+
+  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
+    if identifier.is_a? Java::OrgTmapiCore::Locator
+      addItemIdentifier(identifier)
+    else
+      addItemIdentifier(topic_map.create_locator(identifier))
+    end
+  end
+  alias :item_identifiers= :add_item_identifier
+
+
+  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/locator.rb

@@ -0,0 +1,24 @@
+# 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
+  
+ superised
+  def to_s
+    self.value
+  end
+end

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

@@ -0,0 +1,101 @@
+# 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/Topic-References and must not be empty.
+  #
+  # Datatype may be a Topic-Reference (String or Locator).
+  #
+  # :call-seq:
+  #   create_variant(value, scope) -> Variant
+  #   create_variant(value, datatype, scope) -> Variant
+  #
+  def create_variant(arg1, arg2, arg3 = :nothing)
+    if arg1.is_a?(Java::OrgTmapiCore::Locator)
+      raise("create_variant(value,scope), value: Locator, scope must be an Array") unless arg2.is_a?(Array)
+      if arg2.empty?
+        raise("create_variant(value,scope), value: Locator, scope must not be empty")
+      end
+      arg2.each do |theme|
+        raise("create_variant(value,scope), value: Locator, scope must contain Topic/Topic-References") unless (theme.is_a?(Java::OrgTmapiCore::Topic) || theme.is_a?(String) || theme.is_a?(Java::OrgTmapiCore::Locator))
+      end
+      return createVariant(arg1, topic_map.get!(arg2).to_java(org.tmapi.core.Topic))
+    elsif arg1.is_a?(String) 
+      if arg3 == :nothing 
+        raise("create_variant(value,scope), value: String, scope must be an Array") unless arg2.is_a?(Array)
+        if arg2.empty?
+          raise("create_variant(value,scope), value: String, scope must not be empty")
+        end
+        arg2.each do |theme|
+          raise("create_variant(value,scope), value: String, scope must contain Topic/Topic-References") unless (theme.is_a?(Java::OrgTmapiCore::Topic) || theme.is_a?(String) || theme.is_a?(Java::OrgTmapiCore::Locator))
+        end
+        return createVariant(arg1, topic_map.get!(arg2).to_java(org.tmapi.core.Topic))
+      elsif (arg2.is_a?(Locator) || arg2.is_a?(String))
+        if ((arg2 == RTM::PSI[:String]) || (arg2 == topic_map.create_locator(RTM::PSI[:String])))
+          return createVariant(arg1, topic_map.create_locator(RTM::PSI[:String]), topic_map.get!(arg3))
+        elsif ((arg2 == RTM::PSI[:IRI]) || (arg2 == topic_map.create_locator(RTM::PSI[:IRI])))
+          return createVariant(arg1, topic_map.create_locator(RTM::PSI[:IRI]), topic_map.get!(arg3))
+        elsif ((arg2 == RTM::PSI[:XML]) || (arg2 == topic_map.create_locator(RTM::PSI[:XML])))
+          return createVariant(arg1, topic_map.create_locator(RTM::PSI[:XML]), topic_map.get!(arg3))
+        else 
+          raise("create_variant(value,datatype,scope), value: String, unknown datatype")
+        end
+      else
+        raise("create_variant(value,datatype,scope), datatype must be a String (identifier) or Locator")
+      end 
+    else
+      raise "create_variant: value not a Locator or String"
+    end  
+  end
+  
+end

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

@@ -0,0 +1,56 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module Java::OrgTmapiCore::Occurrence
+  
+  #include RTM::Occurrence
+
+  # 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
+
+
+  # If argument 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=(argument)
+  #
+	def value=(argument)
+		setValue(argument)
+	end
+
+
+
+
+end

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

@@ -0,0 +1,48 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module Java::OrgTmapiCore::Reifiable
+  
+  #include RTM::Reifiable
+  extend Superiseable
+  
+  # Returns the reifier (Topic) of this Reifiable
+  # or nil if the Reifiable is not reified.
+  #
+  # :call-seq:
+  #   reifier -> Topic
+  #
+  def reifier
+    getReifier
+  end
+	
+  # Returns the reifier (Topic) of this Reifiable.
+  # If there is no current reifier, then a reifier will be generated.
+  #
+  # :call-seq:
+  #   reifier! -> Topic
+  #
+	def reifier!
+		self.reifier ||= self.topic_map.create_topic
+	end
+   
+  superised
+  # Sets the reifier of this reifiable Construct.
+  # The specified reifier MUST NOT reify another information item.
+  #
+  # Identifier may be a Topic or Topic-Reference or nil,
+  # if an existing reifier should be removed.
+  #
+  # :call-seq:
+  #   reifier = identifier
+  #   reifier = ()
+  #
+  def reifier=(identifier=nil)
+    unless identifier
+      setReifier(identifier)
+      return
+    end
+    raise("reifier=: identifier muss be a Topic, Locator or String; not given or nil") unless identifier.is_a?(Java::OrgTmapiCore::Topic) || identifier.is_a?(Java::OrgTmapiCore::Locator) || identifier.is_a?(String)
+    setReifier(topic_map.get!(identifier))
+  end
+end

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

@@ -0,0 +1,49 @@
+# Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig.
+# License:   Apache License, Version 2.0
+
+module Java::OrgTmapiCore::Role
+  
+  #include RTM::Role
+  extend Superiseable
+
+  # Returns the Association to which this Role belongs.
+  #
+  # :call-seq:
+  #   parent -> Association
+  #
+  def parent
+		getParent
+	end
+  alias :reverse_children :parent
+
+  # Returns the Topic playing the current Role.
+  #
+  # :call-seq:
+  #   player -> Topic
+  #
+	def player
+		getPlayer
+	end
+
+  superised
+  # Sets the role player. Any previous role player will be overriden.
+  #
+  # Identifier may be a Topic or Topic-Reference.
+  #
+  # :call-seq:
+  #   player=(identifier)
+  #
+	def player=(identifier)
+		setPlayer(topic_map.get!(identifier))
+	end
+  
+  # Returns the identifier of the current Role.
+  # This property has no representation in the Topic Maps - Data Model.
+  #
+  # :call-seq:
+  #   id -> String
+  #
+  def id
+    getId
+  end
+end