rtm-javatmapi 0.2.0 → 0.2.1

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

@@ -2,8 +2,9 @@
 # License:   Apache License, Version 2.0
 
 module Java::OrgTmapiCore::Occurrence
-  
-  #include RTM::Occurrence
+
+  include RTM::Occurrence
+  extend Superiseable
 
   # Returns the Topic this Occurrence belongs to.
   #
@@ -27,30 +28,5 @@ module Java::OrgTmapiCore::Occurrence
 		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

@@ -2,11 +2,11 @@
 # License:   Apache License, Version 2.0
 
 module Java::OrgTmapiCore::Reifiable
-  
-  #include RTM::Reifiable
+
+  include RTM::Reifiable
   extend Superiseable
-  
-  # Returns the reifier (Topic) of this Reifiable
+
+  # Returns the reifier (a topic) of this Reifiable
   # or nil if the Reifiable is not reified.
   #
   # :call-seq:
@@ -15,22 +15,12 @@ module Java::OrgTmapiCore::Reifiable
   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,
+  # Identifier may be a topic reference or nil,
   # if an existing reifier should be removed.
   #
   # :call-seq:
@@ -39,7 +29,7 @@ module Java::OrgTmapiCore::Reifiable
   #
   def reifier=(identifier=nil)
     unless identifier
-      setReifier(identifier)
+      setReifier(nil)
       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)

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

@@ -2,8 +2,8 @@
 # License:   Apache License, Version 2.0
 
 module Java::OrgTmapiCore::Role
-  
-  #include RTM::Role
+
+  include RTM::Role
   extend Superiseable
 
   # Returns the Association to which this Role belongs.
@@ -28,7 +28,7 @@ module Java::OrgTmapiCore::Role
   superised
   # Sets the role player. Any previous role player will be overriden.
   #
-  # Identifier may be a Topic or Topic-Reference.
+  # Identifier may be a topic reference.
   #
   # :call-seq:
   #   player=(identifier)

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

@@ -3,8 +3,8 @@
 
 module Java::OrgTmapiCore::Scoped
 
+  include RTM::Scoped
   extend Superiseable
-  #include RTM::Scoped
 
   # Returns the Topics which define the scope of this scoped Construct.
   # An empty Set represents the unconstrained scope.
@@ -20,7 +20,7 @@ module Java::OrgTmapiCore::Scoped
   superised
   # Adds a topic given by the identifier to the scope.
   #
-  # Identifier may be a Topic or Topic-Reference.
+  # Identifier may be a topic reference.
   #
   # :call-seq:
   #   add_theme(identifier)
@@ -37,7 +37,7 @@ module Java::OrgTmapiCore::Scoped
 
   # Adds one or several topics to the scope.
   #
-  # An identifier may be a Topic or Topic-Reference.
+  # An identifier may be a topic reference.
   #
   # :call-seq:
   #   add_themes(identifier)
@@ -60,24 +60,19 @@ module Java::OrgTmapiCore::Scoped
   superised
   # Removes a topic given by the identifier from the current scope.
   #
-  # Identifier may be a Topic or Topic-Reference.
+  # Identifier may be a topic reference.
   #
   # :call-seq:
   #   remove_theme(identifier)
   #
 	def remove_theme(identifier)
-    if identifier.is_a?(Java::OrgTmapiCore::Topic)
-      removeTheme(identifier)
-    elsif identifier.is_a?(Java::OrgTmapiCore::Locator) || identifier.is_a?(String)
-      removeTheme(topic_map.get!(identifier))
-    else
-      raise("Identifier must be a Topic, String or Locator")
-    end
+    identifier = topic_map.get(identifier)
+    removeTheme(identifier) if identifier.is_a?(Java::OrgTmapiCore::Topic)
 	end
 
   # Removes one or several topics from the scope.
   #
-  # An identifier may be a Topic or Topic-Reference.
+  # An identifier may be a topic reference.
   #
   # :call-seq:
   #   remove_themes(identifier)

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

@@ -2,10 +2,10 @@
 # License:   Apache License, Version 2.0
 
 module Java::OrgTmapiCore::Topic
- 
-  #include RTM::Topic
+
+  include RTM::Topic
   extend Superiseable
- 
+
   # Returns all Names and Occurrences parented by this Topic.
   #
   # :call-seq:
@@ -28,7 +28,7 @@ module Java::OrgTmapiCore::Topic
   # If the identifier equals :default, all Names
   # which have the default Name type are returned.
   #
-  # Identifier may be a Topic/Topic-Reference or Symbol;
+  # Identifier may be a topic reference or Symbol;
   # or an Array of these.
   #
   # :call-seq:
@@ -61,7 +61,7 @@ module Java::OrgTmapiCore::Topic
   # of all Occurrences of this Topic, which have one of
   # the identifiers as Occurrence type. 
   #
-  # Identifier may be a Topic/Topic-Reference or an Array of these.
+  # Identifier may be a topic reference or an Array of these.
   # 
   # :call-seq:
   #   occurrences           -> Set of Occurrences
@@ -87,7 +87,7 @@ module Java::OrgTmapiCore::Topic
   # Creates a Name for this Topic with the specified value.
   # Value has to be a String.
   #
-  # Type may be a Topic/Topic-Reference.
+  # Type may be a topic reference.
   # If given, type specifies the Name Type;
   # else the created Name will have the default name type.
   # 
@@ -104,7 +104,7 @@ module Java::OrgTmapiCore::Topic
   def create_name(arg1,arg2 = :nothing, arg3 = :nothing)
     if (arg2 == :nothing) && (arg3 == :nothing) #arg1 = value
       raise "create_name(value): value must be a String" unless arg1.is_a?(String)
-      return createName(arg1,[].to_java(org.tmapi.core.Topic))
+      return createName(arg1,new_empty_java_topic_array)
     end
     if (arg3 == :nothing)
       if arg2.is_a?(Array) #arg1 = value, arg2 = scope
@@ -112,10 +112,10 @@ module Java::OrgTmapiCore::Topic
         arg2.each do |theme|
           raise "create_name(value, scope): scope must be an Array of Topics/Topic-References" unless (theme.is_a?(String) || theme.is_a?(Java::OrgTmapiCore::Topic) || theme.is_a?(Java::OrgTmapiCore::Locator))
         end
-        return arg2.empty? ? createName(arg1,[].to_java(org.tmapi.core.Topic)) : createName(arg1,topic_map.get!(arg2))
+        return arg2.empty? ? createName(arg1,new_empty_java_topic_array) : createName(arg1,topic_map.get!(arg2))
       elsif arg2.is_a?(String) #arg1 = type, arg2 = value
         raise "create_name(type, value): type must be a Topic/Topic-Reference" unless (arg1.is_a?(String) || arg1.is_a?(Java::OrgTmapiCore::Topic) || arg1.is_a?(Java::OrgTmapiCore::Locator))
-        return createName(topic_map.get!(arg1),arg2,[].to_java(org.tmapi.core.Topic))
+        return createName(topic_map.get!(arg1),arg2,new_empty_java_topic_array)
       else
         raise "create_name(?,?): arguments don't match"
       end
@@ -134,12 +134,12 @@ module Java::OrgTmapiCore::Topic
   # Creates an Occurrence for this Topic with the specified type and value and
   # optional scope and datatype.
   #
-  # Type specifies the Occurrence type and may be a Topic, String or Locator.
+  # Type specifies the Occurrence type and may be a topic reference.
   #
   # Value may be a Locator (then the datatype is set to xsd:AnyURI and
   # must not be given) or String.
   #
-  # Scope may be an Array of Topics/Topic-References. If no scope
+  # Scope may be an Array of topic reference. If no scope
   # is given, the Occurrence will be in the unconstrained scope.
   #
   # Datatype may be a String or Locator and indicates the datatype of the value.
@@ -151,23 +151,55 @@ module Java::OrgTmapiCore::Topic
   #   create_occurrence(type, value, {:datatype => datatype})                  -> Occurrence
   #  
   def create_occurrence(type,value,params={})
-    if params[:scope]
-      raise("scope must be an Array") unless params[:scope].is_a?(Array)
-      if (value.is_a? Java::OrgTmapiCore::Locator) || !params[:datatype]
-        return createOccurrence(topic_map.get!(type),value,topic_map.get!(params[:scope]))
-      else # datatype given, no locator
-        return createOccurrence(topic_map.get!(type),value,topic_map.create_locator(params[:datatype]),topic_map.get!(params[:scope]))
+    # creating a topic for the type
+    type = topic_map.get!(type)
+    # reading the datatype if given. nil otherwise
+    datatype = params[:datatype]
+    # reading value and setting datatype if not done 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
-    else #no scope
-      if (value.is_a? Java::OrgTmapiCore::Locator) || !params[:datatype]
-        return createOccurrence(topic_map.get!(type),value,[].to_java(org.tmapi.core.Topic))
-      else #datatype given, no locator
-        return createOccurrence(topic_map.get!(type),value,topic_map.create_locator(params[:datatype]),[].to_java(org.tmapi.core.Topic))
+    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
+
+    begin
+      if params[:scope]
+        raise("scope must be an Array") unless params[:scope].is_a?(Array)
+
+        return createOccurrence(type, value, datatype, topic_map.get!(params[:scope]))
+
+      else #no scope
+        return createOccurrence(type, value, datatype, new_empty_java_topic_array)
       end
+    rescue java.lang.IllegalArgumentException => iae
+      raise(iae.message)
     end
   end
 
-
   # Returns the TopicMap the Topic belongs to.
   #
   # :call-seq:
@@ -180,7 +212,7 @@ module Java::OrgTmapiCore::Topic
 
   # Calls TMAPI TopicMap.getIndex which
   # returns the index for the TypeInstanceIndex.
-  # 
+  #
   # :call-seq:
   #   type_instance_index -> TypeInstanceIndex
   #
@@ -194,8 +226,8 @@ module Java::OrgTmapiCore::Topic
   # If given, rtype specifies the type of the Roles to be returned;
   # If given, atype specifies the type of the Association
   # from which the returned Roles must be part of.
-  # 
-  # rtype and atype may be a Topic/Topic-Reference or Arrays of these types.
+  #
+  # rtype and atype may be a topic reference or Arrays of these types.
   #
   # The result may be empty.
   #
@@ -263,31 +295,18 @@ module Java::OrgTmapiCore::Topic
   #   add_subject_identifier(identifier)
   #
   def add_subject_identifier(identifier)
-    if identifier.is_a? Java::OrgTmapiCore::Locator
-      addSubjectIdentifier(identifier)
-    else
-      addSubjectIdentifier(topic_map.create_locator(identifier))
+    begin
+      if identifier.is_a? Java::OrgTmapiCore::Locator
+        addSubjectIdentifier(identifier)
+      else
+        addSubjectIdentifier(topic_map.create_locator(identifier))
+      end
+    rescue org.tmapi.core.IdentityConstraintException => ice
+      # TODO add condition to switch off automerge
+      self.mergeIn(self.topic_map.get(identifier))
     end
   end
-  alias :subject_identifiers= :add_subject_identifier
 
-  superised
-  # Adds a subject locator to the current topic.
-  # Identifier may be a String or Locator.
-  #
-  # :call-seq:
-  #   add_subject_locator(identifier)
-  #
-  def add_subject_locator(identifier)
-    # TODO Spec
-    if identifier.is_a? Java::OrgTmapiCore::Locator
-      addSubjectLocator(identifier)
-    else
-      addSubjectLocator(topic_map.create_locator(identifier))
-    end
-  end
-  alias :subject_locators= :add_subject_locator
-  
   superised
   # Removes a subject identifier from the this Topic,
   # if present.
@@ -298,10 +317,39 @@ module Java::OrgTmapiCore::Topic
   #   remove_subject_identifier(identifier)
   #
   def remove_subject_identifier(identifier)
-    identifier = topic_map.create_locator(identifier) if identifier.is_a? String 
+    identifier = topic_map.create_locator(identifier) if identifier.is_a? String
     removeSubjectIdentifier(identifier) if identifier.is_a? Java::OrgTmapiCore::Locator
   end
 
+  # Returns the subject locators assigned to the current topic.
+  #
+  # :call-seq:
+  #   subject_locators -> Set of Locators
+  #
+  def subject_locators
+    getSubjectLocators
+  end
+
+  superised
+  # Adds a subject locator to the current topic.
+  # Identifier may be a String or Locator.
+  #
+  # :call-seq:
+  #   add_subject_locator(identifier)
+  #
+  def add_subject_locator(identifier)
+    # TODO Spec
+    begin
+      if identifier.is_a? Java::OrgTmapiCore::Locator
+        addSubjectLocator(identifier)
+      else
+        addSubjectLocator(topic_map.create_locator(identifier))
+      end
+    rescue org.tmapi.core.IdentityConstraintException => ice
+      # TODO add condition to switch off automerge
+      self.mergeIn(self.topic_map.topic_by_subject_locator(identifier))
+    end
+  end
 
   superised
   # Removes a subject locator from the this Topic,
@@ -313,7 +361,7 @@ module Java::OrgTmapiCore::Topic
   #   remove_subject_locator(identifier)
   #
   def remove_subject_locator(identifier)
-    identifier = topic_map.create_locator(identifier) if identifier.is_a? String 
+    identifier = topic_map.create_locator(identifier) if identifier.is_a? String
     removeSubjectLocator(identifier) if identifier.is_a? Java::OrgTmapiCore::Locator
   end
 
@@ -332,12 +380,12 @@ module Java::OrgTmapiCore::Topic
   #  end
 
   superised
-  # Adds a type given by the identifier to this Topic. 
+  # Adds a type given by the identifier to this Topic.
   #
-  # Identifier may be a Topic or Topic-Reference.
+  # Identifier may be a topic reference.
   #
   # :call-seq:
-  #   add_type(identifier)   
+  #   add_type(identifier)
   #
   def add_type(identifier)
     if identifier.is_a?(Java::OrgTmapiCore::Topic)
@@ -351,7 +399,7 @@ module Java::OrgTmapiCore::Topic
 
   # Adds one or several types given by the identifiers.
   #
-  # Identifier may be a Topic or Topic-Reference.
+  # Identifier may be a topic reference.
   #
   # :call-seq:
   #   add_types(identifier1, identifier2, ...)
@@ -364,12 +412,12 @@ module Java::OrgTmapiCore::Topic
   end
 
 
-  # Adds an instance given by the identifier to this Topic. 
+  # Adds an instance given by the identifier to this Topic.
   #
-  # Identifier may be a Topic or Topic-Reference.
+  # Identifier may be a topic reference.
   #
   # :call-seq:
-  #   add_instance(identifier)   
+  #   add_instance(identifier)
   #
   def add_instance(identifier)
     if identifier.is_a?(Java::OrgTmapiCore::Topic)
@@ -383,7 +431,7 @@ module Java::OrgTmapiCore::Topic
 
   # Adds one or several instances given by the identifiers.
   #
-  # Identifier may be a Topic or Topic-Reference.
+  # Identifier may be a topic reference.
   #
   # :call-seq:
   #   add_instances(identifier1, identifier2, ...)
@@ -416,17 +464,17 @@ module Java::OrgTmapiCore::Topic
   #
   def reified=(identifier)
     if identifier.is_a?(Java::OrgTmapiCore::Reifiable)
-      identifier.reifier = self 
+      identifier.reifier = self
       return
     end
     raise("reified=: Identifier may be a Name, Variant, Occurrence, Association, Role or TopicMap")
   end
 
   superised
-  # Removes a type given by the identifier from this Topic,
+  # Removes a type given by the identifier of this topic,
   # if present.
   #
-  # Identifier may be a Topic or Topic-Reference.
+  # Identifier may be a topic reference.
   #
   # :call-seq:
   #   remove_type(identifier)
@@ -440,6 +488,19 @@ module Java::OrgTmapiCore::Topic
     end
   end
 
+  # Removes an instance given by the identifier of this topic,
+  # if present.
+  #
+  # Identifier may be a topic reference.
+  #
+  # :call-seq:
+  #   remove_instance(identifier)
+  #
+  def remove_instance(identifier)
+    identifier = topic_map.get(identifier)
+    return unless identifier
+    identifier.removeType(self)
+  end
 
   # TODO extend this, maybe allow for a removal of any topic no matter how important
   # it may be for the whole topic map
@@ -448,6 +509,16 @@ module Java::OrgTmapiCore::Topic
     self.remove
   end
 
+  private
+  def new_empty_java_topic_array
+    [].to_java(org.tmapi.core.Topic)
+  end
+
+  class NoDatatypeHandlerAvailableException < Exception
+    def initialize(value)
+      super "Cannot map #{value} to an occurrence value+datatype. Maybe you need to add a handler for your Ruby object type."
+    end
+  end
 end