Class: CardDB::FieldInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/carddb/collection.rb

Overview

Wrapper for FieldInfo

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data) ⇒ FieldInfo

Returns a new instance of FieldInfo.



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

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

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.



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

def data
  @data
end

Instance Method Details

#allowed_values ⇒ Object 



759
760
761
 
# File 'lib/carddb/collection.rb', line 759

def allowed_values
  data['allowedValues']
end

#computed? ⇒ Boolean

Returns:

  • (Boolean) 


747
748
749
 
# File 'lib/carddb/collection.rb', line 747

def computed?
  data['isComputed']
end

#default_value ⇒ Object 



755
756
757
 
# File 'lib/carddb/collection.rb', line 755

def default_value
  data['defaultValue']
end

#description ⇒ Object 



675
676
677
 
# File 'lib/carddb/collection.rb', line 675

def description
  data['description']
end

#display_format ⇒ Object 



731
732
733
 
# File 'lib/carddb/collection.rb', line 731

def display_format
  data['displayFormat']
end

#filterable? ⇒ Boolean

Returns:

  • (Boolean) 


687
688
689
 
# File 'lib/carddb/collection.rb', line 687

def filterable?
  data['filterable']
end

#hidden? ⇒ Boolean

Returns:

  • (Boolean) 


743
744
745
 
# File 'lib/carddb/collection.rb', line 743

def hidden?
  data['isHidden']
end

#identifier? ⇒ Boolean

Returns:

  • (Boolean) 


695
696
697
 
# File 'lib/carddb/collection.rb', line 695

def identifier?
  data['isIdentifier']
end

#item_type ⇒ Object 



703
704
705
 
# File 'lib/carddb/collection.rb', line 703

def item_type
  data['itemType']
end

#key ⇒ Object 



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

def key
  data['key']
end

#label ⇒ Object 



671
672
673
 
# File 'lib/carddb/collection.rb', line 671

def label
  data['label']
end

#link_alias ⇒ Object 



723
724
725
 
# File 'lib/carddb/collection.rb', line 723

def link_alias
  data['linkAlias']
end

#link_dataset_id ⇒ Object 



707
708
709
 
# File 'lib/carddb/collection.rb', line 707

def link_dataset_id
  data['linkDatasetId']
end

#link_dataset_key ⇒ Object 



711
712
713
 
# File 'lib/carddb/collection.rb', line 711

def link_dataset_key
  data['linkDatasetKey']
end

#link_dataset_name ⇒ Object 



715
716
717
 
# File 'lib/carddb/collection.rb', line 715

def link_dataset_name
  data['linkDatasetName']
end

#link_direction ⇒ Object 



727
728
729
 
# File 'lib/carddb/collection.rb', line 727

def link_direction
  data['linkDirection']
end

#link_field_key ⇒ Object 



719
720
721
 
# File 'lib/carddb/collection.rb', line 719

def link_field_key
  data['linkFieldKey']
end

#max_length ⇒ Object 



767
768
769
 
# File 'lib/carddb/collection.rb', line 767

def max_length
  data['maxLength']
end

#max_value ⇒ Object 



775
776
777
 
# File 'lib/carddb/collection.rb', line 775

def max_value
  data['maxValue']
end

#min_length ⇒ Object 



763
764
765
 
# File 'lib/carddb/collection.rb', line 763

def min_length
  data['minLength']
end

#min_value ⇒ Object 



771
772
773
 
# File 'lib/carddb/collection.rb', line 771

def min_value
  data['minValue']
end

#nested_fields ⇒ Object 



787
788
789
 
# File 'lib/carddb/collection.rb', line 787

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

#pattern ⇒ Object 



779
780
781
 
# File 'lib/carddb/collection.rb', line 779

def pattern
  data['pattern']
end

#placeholder ⇒ Object 



739
740
741
 
# File 'lib/carddb/collection.rb', line 739

def placeholder
  data['placeholder']
end

#required? ⇒ Boolean

Returns:

  • (Boolean) 


683
684
685
 
# File 'lib/carddb/collection.rb', line 683

def required?
  data['isRequired']
end

#searchable? ⇒ Boolean

Returns:

  • (Boolean) 


691
692
693
 
# File 'lib/carddb/collection.rb', line 691

def searchable?
  data['searchable']
end

#semantic_type ⇒ Object 



735
736
737
 
# File 'lib/carddb/collection.rb', line 735

def semantic_type
  data['semanticType']
end

#sort_order ⇒ Object 



699
700
701
 
# File 'lib/carddb/collection.rb', line 699

def sort_order
  data['sortOrder']
end

#system_field? ⇒ Boolean

Returns:

  • (Boolean) 


751
752
753
 
# File 'lib/carddb/collection.rb', line 751

def system_field?
  data['isSystemField']
end

#type ⇒ Object 



679
680
681
 
# File 'lib/carddb/collection.rb', line 679

def type
  data['type']
end

#unique? ⇒ Boolean

Returns:

  • (Boolean) 


783
784
785
 
# File 'lib/carddb/collection.rb', line 783

def unique?
  data['isUnique']
end