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.



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

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

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.



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

def data
  @data
end

Instance Method Details

#allowed_values ⇒ Object 



749
750
751
 
# File 'lib/carddb/collection.rb', line 749

def allowed_values
  data['allowedValues']
end

#computed? ⇒ Boolean

Returns:

  • (Boolean) 


737
738
739
 
# File 'lib/carddb/collection.rb', line 737

def computed?
  data['isComputed']
end

#default_value ⇒ Object 



745
746
747
 
# File 'lib/carddb/collection.rb', line 745

def default_value
  data['defaultValue']
end

#description ⇒ Object 



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

def description
  data['description']
end

#display_format ⇒ Object 



721
722
723
 
# File 'lib/carddb/collection.rb', line 721

def display_format
  data['displayFormat']
end

#filterable? ⇒ Boolean

Returns:

  • (Boolean) 


677
678
679
 
# File 'lib/carddb/collection.rb', line 677

def filterable?
  data['filterable']
end

#hidden? ⇒ Boolean

Returns:

  • (Boolean) 


733
734
735
 
# File 'lib/carddb/collection.rb', line 733

def hidden?
  data['isHidden']
end

#identifier? ⇒ Boolean

Returns:

  • (Boolean) 


685
686
687
 
# File 'lib/carddb/collection.rb', line 685

def identifier?
  data['isIdentifier']
end

#item_type ⇒ Object 



693
694
695
 
# File 'lib/carddb/collection.rb', line 693

def item_type
  data['itemType']
end

#key ⇒ Object 



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

def key
  data['key']
end

#label ⇒ Object 



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

def label
  data['label']
end

#link_alias ⇒ Object 



713
714
715
 
# File 'lib/carddb/collection.rb', line 713

def link_alias
  data['linkAlias']
end

#link_dataset_id ⇒ Object 



697
698
699
 
# File 'lib/carddb/collection.rb', line 697

def link_dataset_id
  data['linkDatasetId']
end

#link_dataset_key ⇒ Object 



701
702
703
 
# File 'lib/carddb/collection.rb', line 701

def link_dataset_key
  data['linkDatasetKey']
end

#link_dataset_name ⇒ Object 



705
706
707
 
# File 'lib/carddb/collection.rb', line 705

def link_dataset_name
  data['linkDatasetName']
end

#link_direction ⇒ Object 



717
718
719
 
# File 'lib/carddb/collection.rb', line 717

def link_direction
  data['linkDirection']
end

#link_field_key ⇒ Object 



709
710
711
 
# File 'lib/carddb/collection.rb', line 709

def link_field_key
  data['linkFieldKey']
end

#max_length ⇒ Object 



757
758
759
 
# File 'lib/carddb/collection.rb', line 757

def max_length
  data['maxLength']
end

#max_value ⇒ Object 



765
766
767
 
# File 'lib/carddb/collection.rb', line 765

def max_value
  data['maxValue']
end

#min_length ⇒ Object 



753
754
755
 
# File 'lib/carddb/collection.rb', line 753

def min_length
  data['minLength']
end

#min_value ⇒ Object 



761
762
763
 
# File 'lib/carddb/collection.rb', line 761

def min_value
  data['minValue']
end

#nested_fields ⇒ Object 



777
778
779
 
# File 'lib/carddb/collection.rb', line 777

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

#pattern ⇒ Object 



769
770
771
 
# File 'lib/carddb/collection.rb', line 769

def pattern
  data['pattern']
end

#placeholder ⇒ Object 



729
730
731
 
# File 'lib/carddb/collection.rb', line 729

def placeholder
  data['placeholder']
end

#required? ⇒ Boolean

Returns:

  • (Boolean) 


673
674
675
 
# File 'lib/carddb/collection.rb', line 673

def required?
  data['isRequired']
end

#searchable? ⇒ Boolean

Returns:

  • (Boolean) 


681
682
683
 
# File 'lib/carddb/collection.rb', line 681

def searchable?
  data['searchable']
end

#semantic_type ⇒ Object 



725
726
727
 
# File 'lib/carddb/collection.rb', line 725

def semantic_type
  data['semanticType']
end

#sort_order ⇒ Object 



689
690
691
 
# File 'lib/carddb/collection.rb', line 689

def sort_order
  data['sortOrder']
end

#system_field? ⇒ Boolean

Returns:

  • (Boolean) 


741
742
743
 
# File 'lib/carddb/collection.rb', line 741

def system_field?
  data['isSystemField']
end

#type ⇒ Object 



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

def type
  data['type']
end

#unique? ⇒ Boolean

Returns:

  • (Boolean) 


773
774
775
 
# File 'lib/carddb/collection.rb', line 773

def unique?
  data['isUnique']
end