Class: NexosisApi::VocabularySummary

Inherits:
Object
  • Object
show all
Defined in:
lib/nexosis_api/vocabulary_summary.rb

Overview

parsed results of a request for vocabulary

Since:

  • 2.2.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(vocab_hash) ⇒ VocabularySummary

Returns a new instance of VocabularySummary.

Since:

  • 2.2.0



5
6
7
8
9
10
11
12
13
14
 
# File 'lib/nexosis_api/vocabulary_summary.rb', line 5

def initialize(vocab_hash)
  var_map = { 'id' => :@vocabulary_id,
              'dataSourceName' => :@datasource_name,
              'columnName' => :@column_name,
              'dataSourceType' => :@datasource_type,
              'createdOnDate' => :@created_on,
              'createdBySessionId' => :@created_by_session }
  vocab_hash.each { |k, v| instance_variable_set(var_map[k.to_s], v) unless var_map[k.to_s].nil? }
  @links = vocab_hash['links'].reject(&:nil?).map { |l| NexosisApi::Link.new(l) }
end

Instance Attribute Details

#column_name ⇒ String (readonly)

text-based column name from the datasource

Returns:

  • (String)

Since:

  • 2.2.0



26
27
28
 
# File 'lib/nexosis_api/vocabulary_summary.rb', line 26

def column_name
  @column_name
end

#created_by_session ⇒ String (readonly)

The unique id of the session for which this vocabulary was built.

Returns:

  • (String)

Since:

  • 2.2.0



38
39
40
 
# File 'lib/nexosis_api/vocabulary_summary.rb', line 38

def created_by_session
  @created_by_session
end

#created_on ⇒ DateTime (readonly)

The date on which the vocabulary was created

Returns:

  • (DateTime)

Since:

  • 2.2.0



34
35
36
 
# File 'lib/nexosis_api/vocabulary_summary.rb', line 34

def created_on
  @created_on
end

#datasource_name ⇒ String (readonly)

datasource which contained the text column the vocabulary was built from

Returns:

  • (String)

Since:

  • 2.2.0



22
23
24
 
# File 'lib/nexosis_api/vocabulary_summary.rb', line 22

def datasource_name
  @datasource_name
end

#datasource_type ⇒ String (readonly)

determines if data source was dataSet, View, or other

Returns:

  • (String)

Since:

  • 2.2.0



30
31
32
 
# File 'lib/nexosis_api/vocabulary_summary.rb', line 30

def datasource_type
  @datasource_type
end

#links ⇒ Arrays (readonly)

hypermedia related to this vocabulary

Returns:

  • (Arrays)

Since:

  • 2.2.0



42
43
44
 
# File 'lib/nexosis_api/vocabulary_summary.rb', line 42

def links
  @links
end

#vocabulary_id ⇒ String (readonly)

unique identifier for this vocabulary

Returns:

  • (String)

Since:

  • 2.2.0



18
19
20
 
# File 'lib/nexosis_api/vocabulary_summary.rb', line 18

def vocabulary_id
  @vocabulary_id
end