Module: Java::OrgTmapiCore::Topic

Extends:
Superiseable
Includes:
RTM::Topic
Defined in:
rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb,
rtm-javatmapi/lib/rtm/javatmapi/aliases.rb

Overview

Copyright: Copyright 2009 Topic Maps Lab, University of Leipzig. License: Apache License, Version 2.0

Defined Under Namespace

Classes: NoDatatypeHandlerAvailableException

Instance Method Summary

Methods included from Superiseable

method_added, register_java_implementation, superised, superising

Instance Method Details

- (Object) add_instance(identifier)

Adds an instance given by the identifier to this Topic.

Identifier may be a topic reference.

:call-seq:

  add_instance(identifier)


412
413
414
415
416
417
418
419
420
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 412

def add_instance(identifier)
  if identifier.is_a?(Java::OrgTmapiCore::Topic)
    identifier.addType(self)
  elsif identifier.is_a?(Java::OrgTmapiCore::Locator) || identifier.is_a?(String)
    topic_map.get!(identifier).addType(self)
  else
    raise("Identifier must be a Topic, String or Locator")
  end
end

- (Object) add_instances(*args)

Adds one or several instances given by the identifiers.

Identifier may be a topic reference.

:call-seq:

  add_instances(identifier1, identifier2, ...)


429
430
431
432
433
434
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 429

def add_instances(*args)
  args.flatten!
  args.each do |identifier|
    add_instance(identifier)
  end
end

- (Object) add_subject_identifier(identifier) Also known as: add_si

Adds a subject identifier to the current Topic. Identifier may be a String or Locator.

:call-seq:

  add_subject_identifier(identifier)


287
288
289
290
291
292
293
294
295
296
297
298
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 287

def add_subject_identifier(identifier)
  begin
    if identifier.is_a? Java::OrgTmapiCore::Locator
      addSubjectIdentifier(identifier)
    else
      addSubjectIdentifier(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

- (Object) add_subject_locator(identifier) Also known as: add_sl

Adds a subject locator to the current topic. Identifier may be a String or Locator.

:call-seq:

  add_subject_locator(identifier)


330
331
332
333
334
335
336
337
338
339
340
341
342
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 330

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 Java::OrgTmapiCore::IdentityConstraintException => ice
    # TODO add condition to switch off automerge
    self.mergeIn(self.topic_map.topic_by_subject_locator(identifier))
  end
end

- (Object) add_type(identifier)

Adds a type given by the identifier to this Topic.

Identifier may be a topic reference.

:call-seq:

  add_type(identifier)


380
381
382
383
384
385
386
387
388
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 380

def add_type(identifier)
  if identifier.is_a?(Java::OrgTmapiCore::Topic)
    addType(identifier)
  elsif identifier.is_a?(Java::OrgTmapiCore::Locator) || identifier.is_a?(String)
    addType(topic_map.get!(identifier))
  else
    raise("Identifier must be a Topic, String or Locator")
  end
end

- (Object) add_types(*args)

Adds one or several types given by the identifiers.

Identifier may be a topic reference.

:call-seq:

  add_types(identifier1, identifier2, ...)


397
398
399
400
401
402
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 397

def add_types(*args)
  args.flatten!
  args.each do |identifier|
    add_type(identifier)
  end
end

- (Object) children Also known as: reverse_parent

Returns all Names and Occurrences parented by this Topic.

:call-seq:

  children -> Array of Names and/or Occurrences


14
15
16
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 14

def children
  getNames.to_a + getOccurrences.to_a
end

- (Object) create_name(arg1, arg2 = :nothing, arg3 = :nothing)

Creates a Name for this Topic with the specified value. Value has to be a String.

Type may be a topic reference. If given, type specifies the Name Type; else the created Name will have the default name type.

Scope must be an Array of Topics/Topic-References. If given, scope specifies the Name scope; else the Name is in the unconstrained scope.

:call-seq:

  create_name(value)              -> Name
  create_name(value, scope)       -> Name
  create_name(type, value)        -> Name
  create_name(type, value, scope) -> Name


104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 104

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,new_empty_java_topic_array)
  end
  if (arg3 == :nothing)
    if arg2.is_a?(Array) #arg1 = value, arg2 = scope
      raise "create_name(value, scope): value must be a String" unless arg1.is_a?(String)
      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,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,new_empty_java_topic_array)
    else
      raise "create_name(?,?): arguments don't match"
    end
  end
  #arg1 = type, arg2 = value, arg3 = scope
  raise "create_name(type, value, scope): type must be a Topic/Topic-Reference" unless (arg1.is_a?(String) || arg1.is_a?(Java::OrgTmapiCore::Topic) || arg1.is_a?(Java::OrgTmapiCore::Locator))
  raise "create_name(type, value, scope): value must be a String" unless arg2.is_a?(String)
  raise "create_name(type, value, scope): scope must be an Array" unless arg3.is_a?(Array)
  arg3.each do |theme|
    raise "create_name(type, 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 createName(topic_map.get!(arg1),arg2,topic_map.get!(arg3))
end

- (Object) create_occurrence(type, value, params = {})

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 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 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.

:call-seq:

  create_occurrence(type, value)                                           -> Occurrence
  create_occurrence(type, value, {:scope => scope})                        -> Occurrence
  create_occurrence(type, value, {:datatype => datatype, :scope => scope}) -> Occurrence
  create_occurrence(type, value, {:datatype => datatype})                  -> Occurrence


153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 153

def create_occurrence(type,value,params={})
  # 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
  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

- (Object) force_remove

TODO extend this, maybe allow for a removal of any topic no matter how important it may be for the whole topic map



497
498
499
500
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 497

def force_remove
  self.roles_played.to_a.clone.each{|p| p.parent.remove}
  self.remove
end

- (Object) names(*args) Also known as: n

Returns Names of this Topic.

If identifier is given, returns the Names of this Topic for which the Name type equals identifier. If several identifiers are given, returns the union of all Names of this Topic, which have one of the identifiers as Name type.

If the identifier equals :default, all Names which have the default Name type are returned.

Identifier may be a topic reference or Symbol; or an Array of these.

:call-seq:

  names     -> Set of Names
  names(identifier) -> Set of Names


38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 38

def names(*args)
  identifier = args.flatten
  return getNames if identifier.empty?
  if identifier.size > 1
    result = java.util.HashSet.new
    identifier.each{|i| result.addAll(names(i))}
    return result
  else
    identifier = identifier[0]
    return getNames if identifier == :any
    return getNames(topic_map.get(RTM::PSI[:name_type])) if identifier == :default
    identifier = topic_map.get(identifier)
    return java.util.HashSet.new unless identifier
    return getNames(identifier)
  end
end

- (Object) occurrences(*args) Also known as: o

Returns Occurrences of this Topic.

If identifier is given, returns the Occurrences of this Topic for which the Occurrence type equals identifier. If several identifiers are given, returns the union of all Occurrences of this Topic, which have one of the identifiers as Occurrence type.

Identifier may be a topic reference or an Array of these.

:call-seq:

  occurrences           -> Set of Occurrences
  occurrences(identifier) -> Set of Occurrences


70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 70

def occurrences(*args)
  identifier = args.flatten
  return getOccurrences if identifier.empty?
  if identifier.size > 1
    result = java.util.HashSet.new
    identifier.each{|i| result.addAll(occurrences(i))}
    return result
  else
    identifier = identifier[0]
    return getOccurrences if identifier == :any
    identifier = topic_map.get(identifier)
    return java.util.HashSet.new unless identifier
    return getOccurrences(identifier)
  end
end

- (Object) parent Also known as: reverse_children

Returns the TopicMap the Topic belongs to.

:call-seq:

  parent -> TopicMap


208
209
210
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 208

def parent
  getParent
end

- (Object) reified

Returns the reifiable Construct which is reified by this Topic or nil if this Topic does not reify a statement.

:call-seq:

  reifier -> Name, Occurrence, Variant, Association, Role or TopicMap


442
443
444
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 442

def reified
  getReified
end

- (Object) reified=(identifier)

Sets this Topic as reifier of the reifiable Construct, given by the identifier.

Identifier may be a Name, Variant, Occurrence, Association, Role or TopicMap.

:call-seq:

  reified = identifier


455
456
457
458
459
460
461
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 455

def reified=(identifier)
  if identifier.is_a?(Java::OrgTmapiCore::Reifiable)
    identifier.reifier = self
    return
  end
  raise("reified=: Identifier may be a Name, Variant, Occurrence, Association, Role or TopicMap")
end

- (Object) remove_instance(identifier)

Removes an instance given by the identifier of this topic, if present.

Identifier may be a topic reference.

:call-seq:

  remove_instance(identifier)


489
490
491
492
493
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 489

def remove_instance(identifier)
  identifier = topic_map.get(identifier)
  return unless identifier
  identifier.removeType(self)
end

- (Object) remove_subject_identifier(identifier) Also known as: remove_si

Removes a subject identifier from the this Topic, if present.

Identifier may be a String or Locator.

:call-seq:

  remove_subject_identifier(identifier)


309
310
311
312
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 309

def remove_subject_identifier(identifier)
  identifier = topic_map.create_locator(identifier) if identifier.is_a? String
  removeSubjectIdentifier(identifier) if identifier.is_a? Java::OrgTmapiCore::Locator
end

- (Object) remove_subject_locator(identifier) Also known as: remove_sl

Removes a subject locator from the this Topic, if present.

Identifier may be a String or Locator.

:call-seq:

  remove_subject_locator(identifier)


353
354
355
356
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 353

def remove_subject_locator(identifier)
  identifier = topic_map.create_locator(identifier) if identifier.is_a? String
  removeSubjectLocator(identifier) if identifier.is_a? Java::OrgTmapiCore::Locator
end

- (Object) remove_type(identifier)

Removes a type given by the identifier of this topic, if present.

Identifier may be a topic reference.

:call-seq:

  remove_type(identifier)


472
473
474
475
476
477
478
479
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 472

def remove_type(identifier)
  if identifier.is_a? Java::OrgTmapiCore::Topic
    removeType(identifier)
  else
    identifier = topic_map.get(identifier)
    removeType(identifier) if identifier
  end
end

- (Object) roles_played(rtype = :any, atype = :any) Also known as: roles

Returns the Roles played by this 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 reference or Arrays of these types.

The result may be empty.

:call-seq:

  roles               -> Array of Roles
  roles(rtype)        -> Array of Roles
  roles(rtype, atype) -> Array of Roles


229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 229

def roles_played(rtype=:any, atype=:any)

  if rtype == :any # -> atype may only be :any
    if atype == :any
      return getRolesPlayed
    else
      raise "Associationtype may only be specified if rtype are specified"
    end
  end

  # Assume, that rtype is given or set to nil
  # atype may be :any
  rtype = topic_map.get(rtype)
  return Array.new if rtype == nil || (rtype.is_a?(Array) && rtype.include?(nil))
  #Assume that rtype is given and found

  unless atype == :any
    atype =  topic_map.get(atype)
    return Array.new if atype == nil || (atype.is_a?(Array) && atype.include?(nil))
  end
  #Assume that if atype is given, it's found

  if rtype.is_a?(Array) #several rtype
    if atype == :any #no atype
      return rtype.map{|r| roles_played(r)}.inject(java.util.HashSet.new){|union,element| union.addAll(element); union}
    elsif atype.is_a?(Array) #several atype
      return rtype.map{|r| roles_played(r,atype)}.inject(java.util.HashSet.new){|union,element| union.addAll(element); union}
    else #one associationtype
      return rtype.map{|r| roles_played(r,atype)}.inject(java.util.HashSet.new){|union,element| union.addAll(element); union}
    end
  else #one roletype
    if atype == :any #no atype
      return getRolesPlayed(rtype)
    elsif atype.is_a?(Array) #several atype
      return atype.map{|a| roles_played(rtype,a)}.inject(java.util.HashSet.new){|union,element| union.addAll(element); union}
    else #one associationtype
      return getRolesPlayed(rtype,atype)
    end
  end
end

- (Object) subject_identifiers Also known as: si

Returns the subject identifiers assigned to the current topic.

:call-seq:

  subject_identifiers -> Set of Locators


276
277
278
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 276

def subject_identifiers
  getSubjectIdentifiers
end

- (Object) subject_locators Also known as: sl

Returns the subject locators assigned to the current topic.

:call-seq:

  subject_locators -> Set of Locators


319
320
321
# File 'rtm-javatmapi/lib/rtm/javatmapi/core/topic.rb', line 319

def subject_locators
  getSubjectLocators
end