Home

![Encapsule Project onm Library](wiki/ivory_sphere_250x250.jpg "Encapsule Project onm Library "Encapsule Project onm Library")

• GitHub: Encapsule/onm • (MIT License)
• Package: npm install onm
• JSFIDDLE examples: http://jsfiddle.net/user/Encapsule
• Test App: http://schema.encapsule.org
• Discussion: ONMjs Google Group
• News: http://blog.encapsule.org
• Twitter: @Encapsule

onm Library Documentation

Getting Started

• Introducing onm
• Quick Facts
• Benefits
• How It Works

Concepts

Articles in this section introduce the core concepts and programming model of the onm library.

MSOFS Design Pattern

Applications that leverage onm are based on the Model-Store-Observe-Feedback-Signal pattern - a more granular and powerful alternative to Model-View-Controller.

• Model-Store-Observe-Feedback-Signal Pattern
• Separation of Concerns
• Applying the MSOFS Pattern

Data Modelling

Applications that leverage onm model their data declaratively to unlock the power of data addressing and introspection.

• Getting Started
• Hierarchical Namespace Declarations
• Extension Point and Component Declarations
• Recursive Namespace Hierarchies
• Namespace Property Declarations
• Application-Specific Meta-Data Declarations
• Semantic Bindings

Data Addressing

All data managed my onm is addressed via resource identifiers enabling the creation of decoupled, generic, and composable subsystems.

• Getting Started
• Address Space Concept
• Address Paths, Path ID's, and Keys
  • Address Paths
  • Address Path ID's
  • Address Keys
• onm.Address Class
  • onm.AddressToken Class
  • Working with onm.AddressToken
  • onm Address Helper Functions
• String Representation of Addresses
  • Human-Readable String
  • Uniform Resource Identifiers (URI)

Data Storage & Access

onm provides powerful powerful infrastructure for managing and working with your data generically.

• Getting Started
• Store Objects
• Namespace Objects
• JSON Import & Export
• Namespace Addressing
• Component Enumeration
• Namespace Enumeration
• Using Multiple Stores
• Building Custom Stores

Data Change Signals

Applications that leverage onm are reactive, event-driven systems, actuated by internal and external changes to data that are communicated to your application via signals.

• Getting Started
• Signal Actuation Events
• Signals
  • onObserverAttachBegin
  • onObserverAttachEnd
  • onObserverDetachBegin
  • onObserverDetachEnd
  • onComponentCreated
  • onComponentRemoved
  • onComponentUpdated
  • onSubcomponentUpdated
  • onNamespaceCreated
  • onNamespaceRemoved
  • onNamespaceUpdated
  • onSubnamespaceUpdated

Observers and Signal Handling

Building onm-based applications involves writing observer subroutines that monitor and react to data changes.

• Getting Started
• Observer Definition Syntax
  • Observer Interface
  • Signal Handler Functions
• Data Change Event Signal Monitoring
  • Identification
  • Registration
  • Unregistration
  • Attach and Detach Event Signals
  • Component Add Event Signals
  • Component Remove Event Signals
  • Namespace Update Event Signals
• Reacting to Data Change Event Signals
  • Accessing Run-Time Data
  • Accessing Model Meta-Data
  • Navigating the Namespace Hierarchy
• Managing Observer Run-Time State Data
  • Observer State Data
  • Observer Component State Data
  • Observer Namespace State Data
  • Inter-Observer State Data
• Inter-Observer Communication
  • Indirect Communication via Signals
  • Coupling via Inter-Observer State Data
• Advanced Scenarios
  • Multiple Stores
  • Multiple Observer

Core Library Object API Reference

Guide to onm core library objects and methods included in the ONMjs-lib-core-*.js packages.

onm.Model Object

• Construction
• Properties
  • onm.Model.description
  • onm.Model.jsonTag
  • onm.Model.label
• Address Creation API Methods
  • onm.Model.createAddressFromHashString
  • onm.Model.createAddressFromHumanReadableString
  • onm.Model.createRootAddress
  • onm.Model.createPathAddress
• Utility API Methods
  • onm.Model.getSemanticBindings
  • onm.Model.isEqual

onm.Store Object

• Construction
• Properties
  • onm.Store.description
  • onm.Store.jsonTag
  • onm.Store.label
  • onm.Store.model
• Data API Methods
  • onm.Store.createComponent
  • onm.Store.removeComponent
  • onm.Store.openNamespace
  • onm.Store.toJSON
• Observer Registration API Methods
  • onm.Store.registerObserver
  • onm.Store.unregisterObserver
• Observer Helper API Methods
  • onm.Store.openObserverState
  • onm.Store.openObserverComponentState
  • onm.Store.openObserverNamespaceState
  • onm.Store.removeObserverState
  • onm.Store.removeObserverNamespaceState
• Utility API Methods
  • onm.Store.validateAddressModel

onm.Address Object

• Construction
• Properties
  • onm.Address.model
• Bound Model API Methods
  • onm.Address.getModel
  • onm.Address.getPropertiesModel
• String Representation API Methods
  • onm.Address.getHumanReadableString
  • onm.Address.getHashString
  • onm.Address.getComponentKey
• Address Creation API Methods
  • onm.Address.createComponentAddress
  • onm.Address.createParentAddress
  • onm.Address.createSubcomponentAddress
  • onm.Address.createSubpathAddress
• Address Visitor API Methods
  • onm.Address.visitChildAddresses
  • onm.Address.visitExtensionPointAddresses
  • onm.Address.visitParentAddressesAscending
  • onm.Address.visitParentAddressesDescending
  • onm.Address.visitSubaddressesAscending
  • onm.Address.visitSubaddressesDescending
• Utility API Methods
  • onm.Address.clone
  • onm.Address.isCreatable
  • onm.Address.isEqual
  • onm.Address.isParent
  • onm.Address.isRoot
  • onm.Address.isSameType

onm.Namespace Object

• Construction
• Properties
  • onm.Namespace.store
• Data API Methods
  • onm.Namespace.data
  • onm.Namespace.toJSON
  • onm.Namespace.fromData
  • onm.Namespace.fromJSON
• Address API Methods
  • onm.Namespace.getResolvedAddress
  • onm.Namespace.getComponentKey
• Semantic Binding API Methods
  • onm.Namespace.getResolvedLabel
• Observer Helper API Methods
  • onm.Namespace.visitExtensionPointSubcomponents
  • onm.Namespace.getExtensionPointSubcomponentCount

onm.CachedAddress Object

• Construction
• Properties
  • onm.AddressStore.referenceStore
• API Methods
  • onm.CachedAddress.getAddress
  • onm.CachedAddress.setAddress

Observer Objects

Observer objects are included in ONMjs-lib-observer-*.js packages and are not required. Currently, all of these objects depend the Knockout.js MVVM framework.

For now, these are direct links to the source CoffeeScript implementation files. Or, you can browse the compiled JavaScript of you prefer.

Please post questions to the ONMjs Googgle Group.

• onm.observers.GenericTest Object
• onm.observers.NavigatorModelView Object
  • onm.observers.NavigatorItemModelView Object
• onm.observers.SelectedJsonModelView Object
• onm.observers.SelectedNamespaceModelView Object
  • onm.observers.SelectedNamespaceActionsModelView Object
  • onm.observers.SelectedNamespaceChildrenModelView Object
  • onm.observers.SelectedNamespaceCollectionModelView Object
  • onm.observers.SelectedNamespaceComponentModelView Object
  • onm.observers.SelectedNamespaceImmutablePropertiesModelView Object
  • onm.observers.SelectedNamespaceMutablePropertiesModelView Object
  • onm.observers.SelectedNamespaceTitleModelView Object
• onm.observers.SelectedPathModelView Object
  • onm.observers.SelectedPathElementModelView Object
• onm.observers.helpers.AddressSelectionLinkModelView Object
• onm.observers.helpers.CallbackLinkModelView Object

---

Copyright (C) 2013 Christopher D. Russell