Home

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

And from the dragon we learn to ride the wind. -- Master Kan

GitHub: Encapsule/ONMjs (MIT License) • Download: http://onmjs.encapsule.org/lib/ • Test App: http://schema.encapsule.org

Object Namespace Manager (ONMjs) is a data model management library written in Javascript that helps you separate concerns at design time, and build elegantly decoupled, reactive, web applications and components. Continue Reading...

ONMjs Library Documentation

Getting Started

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

Programming Model Guide

Articles in this section provide an overview of the theory and application of the ONMjs library that are intended to help you learn to use ONMjs effectively in your own projects.

MSOFS Design Pattern

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

Data Modelling

• 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

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

Data Storage & Access

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

Data Change Signals

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

Observers and Signal Handling

• 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
    • Working Directly With Addresses
    • Visiting Parent Namespaces
    • Visiting Child Namespaces
    • Visiting Extension Point Namespaces
    • Visiting Subcomponent Namespaces
• 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

Programming API Reference

Articles in this section documents ONMjs' core JavaScript classes and provides a quick explanation of each class' purpose, construction, properties, and methods.

Core Classes

Core classes are included in the ONMjs-lib-core-*.js packages and are required to use ONMjs.

ONMjs.Model Class

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

ONMjs.Store Class

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

ONMjs.Address Class

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

ONMjs.CachedAddress Class

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

ONMjs.Namespace Class

• Construction
• Properties
  • ONMjs.Namespace.store
• Data API Methods
  • ONMjs.Namespace.data
  • ONMjs.Namespace.toJSON
• Address API Methods
  • ONMjs.Namespace.getResolvedAddress
• Semantic Binding API Methods
  • ONMjs.Namespace.getResolvedLabel
• Observer Helper API Methods
  • ONMjs.Namespace.visitExtensionPointSubcomponents

Observer Classes

Observer classes are included in ONMjs-lib-observer-*.js packages and are not required.

For now, these are direct links to the source CoffeeScript implementation files. Note that these observers depend on the Knockout.js MVVM framework and are optional. If you have questions please post them in the ONMjs Googgle Group.

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

---

Copyright (C) 2013 Christopher D. Russell