Class: Rfm::Metadata::Field

Inherits:
Object show all
Defined in:
lib/rfm/metadata/field.rb

Overview

The Field object represents a single FileMaker field. It *does not hold the data* in the field. Instead, it serves as a source of metadata about the field. For example, if you’re script is trying to be highly dynamic about its field access, it may need to determine the data type of a field at run time. Here’s how:

field_name = "Some Field Name"
case myRecord.fields[field_name].result
when "text"
  # it is a text field, so handle appropriately
when "number"
  # it is a number field, so handle appropriately
end

Attributes

The Field object has the following attributes:

  • name is the name of the field

  • result is the data type of the field; possible values include:

    • text

    • number

    • date

    • time

    • timestamp

    • container

  • type any of these:

    • normal (a normal data field)

    • calculation

    • summary

  • max_repeats is the number of repetitions (1 for a normal field, more for a repeating field)

  • global is true is this is a global field, false otherwise

Note: Field types match FileMaker’s own values, but the terminology differs. The result attribute tells you the data type of the field, regardless of whether it is a calculation, summary, or normal field. So a calculation field whose result type is timestamp would have these attributes:

  • result: timestamp

  • type: calculation

  • *control& is a FieldControl object representing the sytle and value list information associated with this field on the layout.

Note: Since a field can sometimes appear on a layout more than once, control may be an Array. If you don’t know ahead of time, you’ll need to deal with this. One easy way is:

controls = [myField.control].flatten
controls.each {|control|
  # do something with the control here
}

The code above makes sure the control is always an array. Typically, though, you’ll know up front if the control is an array or not, and you can code accordingly.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(field, options = {}) ⇒ Field

Initializes a field object. You’ll never need to do this. Instead, get your Field objects from ResultSet::fields



66
67
68
69
70
71
72
 
# File 'lib/rfm/metadata/field.rb', line 66

def initialize(field, options={})
  @name        = options[:field_mapping][field.name] || field.name rescue field.name #['name']
  @result      = field.result #['result']
  @type        = field.type #['type']
  @max_repeats = field.max_repeats #['max-repeats']
  @global      = field.global #['global']
end

Instance Attribute Details

#global ⇒ Object (readonly)

Returns the value of attribute global.



62
63
64
 
# File 'lib/rfm/metadata/field.rb', line 62

def global
  @global
end

#max_repeats ⇒ Object (readonly)

Returns the value of attribute max_repeats.



62
63
64
 
# File 'lib/rfm/metadata/field.rb', line 62

def max_repeats
  @max_repeats
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



62
63
64
 
# File 'lib/rfm/metadata/field.rb', line 62

def name
  @name
end

#result ⇒ Object (readonly)

Returns the value of attribute result.



62
63
64
 
# File 'lib/rfm/metadata/field.rb', line 62

def result
  @result
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



62
63
64
 
# File 'lib/rfm/metadata/field.rb', line 62

def type
  @type
end

Instance Method Details

#coerce(value, resultset) ⇒ Object

Coerces the text value from an fmresultset document into proper Ruby types based on the type of the field. You’ll never need to do this: Rfm does it automatically for you when you access field data through the Record object.



77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/rfm/metadata/field.rb', line 77

def coerce(value, resultset)
  return nil if (value.nil? or value.empty?)
  case self.result.downcase
  when "text"      then value
  when "number"    then BigDecimal.new(value.to_s)
  when "date"      then Date.strptime(value, resultset.date_format)
  when "time"      then DateTime.strptime("1/1/-4712 #{value}", "%m/%d/%Y #{resultset.time_format}")
  when "timestamp" then DateTime.strptime(value, resultset.timestamp_format)
  when "container" then URI.parse("#{resultset.server.scheme}://#{resultset.server.host_name}:#{resultset.server.port}#{value}")
  else nil
  end
  
end