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.



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

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

Instance Attribute Details

#dataObject (readonly)

Returns the value of attribute data.



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

def data
  @data
end

Instance Method Details

#allowed_valuesObject



809
810
811
# File 'lib/carddb/collection.rb', line 809

def allowed_values
  data['allowedValues']
end

#computed?Boolean

Returns:

  • (Boolean)


797
798
799
# File 'lib/carddb/collection.rb', line 797

def computed?
  data['isComputed']
end

#default_valueObject



805
806
807
# File 'lib/carddb/collection.rb', line 805

def default_value
  data['defaultValue']
end

#descriptionObject



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

def description
  data['description']
end

#display_formatObject



781
782
783
# File 'lib/carddb/collection.rb', line 781

def display_format
  data['displayFormat']
end

#filterable?Boolean

Returns:

  • (Boolean)


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

def filterable?
  data['filterable']
end

#hidden?Boolean

Returns:

  • (Boolean)


793
794
795
# File 'lib/carddb/collection.rb', line 793

def hidden?
  data['isHidden']
end

#identifier?Boolean

Returns:

  • (Boolean)


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

def identifier?
  data['isIdentifier']
end

#item_typeObject



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

def item_type
  data['itemType']
end

#keyObject



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

def key
  data['key']
end

#labelObject



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

def label
  data['label']
end


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

def link_alias
  data['linkAlias']
end


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

def link_dataset_id
  data['linkDatasetId']
end


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

def link_dataset_key
  data['linkDatasetKey']
end


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

def link_dataset_name
  data['linkDatasetName']
end


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

def link_direction
  data['linkDirection']
end


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

def link_field_key
  data['linkFieldKey']
end

#max_lengthObject



817
818
819
# File 'lib/carddb/collection.rb', line 817

def max_length
  data['maxLength']
end

#max_valueObject



825
826
827
# File 'lib/carddb/collection.rb', line 825

def max_value
  data['maxValue']
end

#min_lengthObject



813
814
815
# File 'lib/carddb/collection.rb', line 813

def min_length
  data['minLength']
end

#min_valueObject



821
822
823
# File 'lib/carddb/collection.rb', line 821

def min_value
  data['minValue']
end

#nested_fieldsObject



837
838
839
# File 'lib/carddb/collection.rb', line 837

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

#patternObject



829
830
831
# File 'lib/carddb/collection.rb', line 829

def pattern
  data['pattern']
end

#placeholderObject



789
790
791
# File 'lib/carddb/collection.rb', line 789

def placeholder
  data['placeholder']
end

#required?Boolean

Returns:

  • (Boolean)


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

def required?
  data['isRequired']
end

#searchable?Boolean

Returns:

  • (Boolean)


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

def searchable?
  data['searchable']
end

#semantic_typeObject



785
786
787
# File 'lib/carddb/collection.rb', line 785

def semantic_type
  data['semanticType']
end

#sort_orderObject



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

def sort_order
  data['sortOrder']
end

#system_field?Boolean

Returns:

  • (Boolean)


801
802
803
# File 'lib/carddb/collection.rb', line 801

def system_field?
  data['isSystemField']
end

#typeObject



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

def type
  data['type']
end

#unique?Boolean

Returns:

  • (Boolean)


833
834
835
# File 'lib/carddb/collection.rb', line 833

def unique?
  data['isUnique']
end