Class: CardDB::FieldInfo

Inherits:

Object

• Object
• CardDB::FieldInfo

Defined in:

lib/carddb/collection.rb

Overview

Wrapper for FieldInfo

Instance Attribute Summary

• #data ⇒ Object readonly

  Returns the value of attribute data.

Instance Method Summary

• #allowed_values ⇒ Object
• #description ⇒ Object
• #display_format ⇒ Object
• #filterable? ⇒ Boolean
• #identifier? ⇒ Boolean
• #initialize(data) ⇒ FieldInfo constructor

  A new instance of FieldInfo.

• #item_type ⇒ Object
• #key ⇒ Object
• #label ⇒ Object
• #nested_fields ⇒ Object
• #required? ⇒ Boolean
• #searchable? ⇒ Boolean
• #semantic_type ⇒ Object
• #type ⇒ Object

Constructor Details

#initialize(data) ⇒ FieldInfo

Returns a new instance of FieldInfo.

# File 'lib/carddb/collection.rb', line 617

def initialize(data)
  @data = data || {}
end

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.

# File 'lib/carddb/collection.rb', line 615

def data
  @data
end

Instance Method Details

#allowed_values ⇒ Object

# File 'lib/carddb/collection.rb', line 665

def allowed_values
  data['allowedValues']
end

#description ⇒ Object

# File 'lib/carddb/collection.rb', line 629

def description
  data['description']
end

#display_format ⇒ Object

# File 'lib/carddb/collection.rb', line 657

def display_format
  data['displayFormat']
end

#filterable? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/carddb/collection.rb', line 641

def filterable?
  data['filterable']
end

#identifier? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/carddb/collection.rb', line 649

def identifier?
  data['isIdentifier']
end

#item_type ⇒ Object

# File 'lib/carddb/collection.rb', line 653

def item_type
  data['itemType']
end

#key ⇒ Object

# File 'lib/carddb/collection.rb', line 621

def key
  data['key']
end

#label ⇒ Object

# File 'lib/carddb/collection.rb', line 625

def label
  data['label']
end

#nested_fields ⇒ Object

# File 'lib/carddb/collection.rb', line 669

def nested_fields
  @nested_fields ||= (data['nestedFields'] || []).map { |f| FieldInfo.new(f) }
end

#required? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/carddb/collection.rb', line 637

def required?
  data['isRequired']
end

#searchable? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/carddb/collection.rb', line 645

def searchable?
  data['searchable']
end

#semantic_type ⇒ Object

# File 'lib/carddb/collection.rb', line 661

def semantic_type
  data['semanticType']
end

#type ⇒ Object

# File 'lib/carddb/collection.rb', line 633

def type
  data['type']
end