Class: SC.RecordAttribute

Extends SC.Object.

A RecordAttribute describes a single attribute on a record. It is used to generate computed properties on records that can automatically convert data types and verify data.

When defining an attribute on an SC.Record, you can configure it this way:

title: SC.Record.attr(String, {
  defaultValue: 'Untitled',
  isRequired: YES|NO
})

In addition to having predefined transform types, there is also a way to set a computed relationship on an attribute. A typical example of this would be if you have record with a parentGuid attribute, but are not able to determine which record type to map to before looking at the guid (or any other attributes). To set up such a computed property, you can attach a function in the attribute definition of the SC.Record subclass:

relatedToComputed: SC.Record.toOne(function() {
  return (this.readAttribute('relatedToComputed').indexOf("foo")==0) ? MyApp.Foo : MyApp.Bar;
})

Notice that we are not using .get() to avoid another transform which would trigger an infinite loop.

You usually will not work with RecordAttribute objects directly, though you may extend the class in any way that you like to create a custom attribute.

A number of default RecordAttribute types are defined on the SC.Record.

Defined in: record_attribute.js

See:

SC.Record

SC.ManyAttribute

SC.SingleAttribute

Since:

SproutCore 1.0

Field Summary

Instance Methods

• apply(target, args)
• attr(attributeType, opts)
• call(record, key, value)
• fromType(record, key, value)
• registerTransform(klass, transform)
• toType(record, key, value)
• transform()
• typeClass()

{
  to: function(value, attr, type, record, key) {
    if(value) return value.toSet();
    else return SC.Set.create();
  },

  from: function(value, attr, type, record, key) {
    return value.toArray();
  },

  observesChildren: ['[]']
}