/* <copyright>
 This file contains proprietary software owned by Motorola Mobility, Inc.<br/>
 No rights, expressed or implied, whatsoever to this software are provided by Motorola Mobility, Inc. hereunder.<br/>
 (c) Copyright 2011 Motorola Mobility, Inc.  All Rights Reserved.
 </copyright> */
/**
 @module montage/data/object-property
 @requires montage/data/pledge
 @requires montage/core/core
 @requires montage/core/exception
 @requires montage/core/logger
 */
var Montage = require("montage").Montage;
var Exception = require("core/exception").Exception;
var Pledge = require("data/pledge").Pledge;
var PledgedSortedSet = require("data/pledge").PledgedSortedSet;
var logger = require("core/logger").logger("object-property");
/**
 Description TODO
 @private
 */
var _objectPropertyManager = null;
/**
 @class module:montage/data/object-property.ObjectProperty
 @extends module:montage/core/core.Montage
 */
var ObjectProperty = exports.ObjectProperty = Montage.create(Montage, /** @lends module:montage/data/object-property.ObjectProperty# */ {
    /**
     Description TODO
     @function
     @returns itself
     */
    init:{
        serializable:false,
        enumerable:false,
        value:function () {
            return this;
        }
    },

    /**
     Add all the properties defined in the blueprint to the target prototype.<br>
     If the blueprint is null, this method will make a best attempt to locate it.
     @function
     @param {Property} prototype TODO
     @param {Object} blueprint TODO
     */
    apply:{
        value:function (prototype, blueprint) {
            if (!prototype.hasOwnProperty("blueprint")) {
                var info;
                info = Montage.getInfoForObject(prototype);
                if (info != null && info.isInstance === false) {
                    if (typeof blueprint === "undefined") {
                        blueprint = Store.defaultManager.blueprintForPrototype(info.objectName, info.moduleId);
                    } else if ((blueprint.prototypeName !== info.objectName) || (blueprint.moduleId !== info.moduleId)) {
                        // Something is wrong, the hierarchies are out of wack
                        blueprint = null;
                    }
                    this.applyWithBlueprint(prototype, blueprint);
                }
            }
        }
    },

    /**
     Add all the properties defined in the blueprint to the target prototype.<br/>
     <b>Note:<b/>This method will explore the blueprint hierarchy recursively.
     @function
     @param {Property} prototype TODO
     @param {Object} blueprint TODO
     */
    applyWithBlueprint:{
        value:function (prototype, blueprint) {
            if (blueprint != null) {
                this.addProperties(prototype, blueprint);
                if (blueprint.parent !== null) {
                    this.apply(Object.getPrototypeOf(prototype), blueprint);
                }
            }
        }
    },
    /**
     Add all the properties defined in the blueprint to the target prototype.
     @function
     @param {Property} prototype TODO
     @param {Object} blueprint TODO
     */
    addProperties:{
        value:function (prototype, blueprint) {
            //for loop over attributes
            var i, attribute;
            for (i = 0; attribute = blueprint.attributes[i]; i++) {
                if (attribute.isDerived) {
                    this.addDerivedProperty(prototype, attribute);
                } else if (attribute.isAssociation) {
                    this.addAssociation(prototype, attribute);
                } else {
                    this.addProperty(prototype, attribute);
                }
            }

            Montage.defineProperty(prototype, "context", { serializable:false, enumerable:true, value:null });
            Montage.defineProperty(prototype, "_objectId", { serializable:true, enumerable:false, value:null });
            Montage.defineProperty(prototype, "objectId", {
                enumerable:true,
                serializable:false,
                get:function () {
                    if (this._objectId === null) {
                        this._objectId = this.blueprint.objectId$Implementation;
                    }
                    return this._objectId;
                },
                set:function (value) {
                    if (value !== null) {
                        this._objectId = value;
                    } else {
                        throw Exception.create().initWithMessageTargetAndMethod("Cannot set object Id to null", this, "objectId.set");
                    }
                }
            });
            Montage.defineProperty(prototype, "_blueprint", { serializable:false, enumerable:false, value:blueprint });
            Montage.defineProperty(prototype, "blueprint", { enumerable:false, serializable:false, get:function () {
                return this._blueprint;
            }});
            Montage.defineProperty(prototype, "isPledge", { serializable:false, enumerable:true, value:false });
            Montage.defineProperty(prototype, "withProperties", { serializable:false, enumerable:false, value:function () {
                return null;
            }});
            Montage.defineProperty(prototype, "willRead", { serializable:false, enumerable:false, value:this.willRead });
            Montage.defineProperty(prototype, "willModify", { serializable:false, enumerable:false, value:this.willModify });
            // Enable access to the 'inherited' get method for easy override.
            Montage.defineProperty(prototype, "blueprintGet", { serializable:false, enumerable:false, value:blueprint.blueprintGet});
            // Enable access to the 'inherited' set method for easy override.
            Montage.defineProperty(prototype, "blueprintSet", { serializable:false, enumerable:false, value:blueprint.blueprintSet});
            // Provide a storage property for any state the access layer need to store in teh object. This would typically be a database snapshot reference.
            Montage.defineProperty(prototype, "_opaqueAccessState", { serializable:false, enumerable:false, value:null});
        }
    },
    /**
     Add one property defined in the attribute to the target prototype.
     @function
     @param {Property} prototype TODO
     @param {Object} attribute TODO
     */
    addProperty:{
        value:function (prototype, attribute) {
            this.addPropertyStorage(prototype, attribute);
            this.addPropertyDefinition(prototype, attribute);
            this.addPropertyStoredValue(prototype, attribute);
        }
    },
    /**
     Description TODO
     @function
     @param {Property} prototype TODO
     @param {Object} attribute TODO
     */
    addPropertyStorage:{
        value:function (prototype, attribute) {
            var storageKey = "_" + attribute.name,
                storageDefinition = null;
            if (!prototype.hasOwnProperty(storageKey)) {
                if (attribute.isToMany) {
                    storageDefinition = {
                        value:[],
                        enumerable:false,
                        serializable:true,
                        distinct:true
                    };
                } else {
                    storageDefinition = {
                        value:null,
                        enumerable:false,
                        serializable:true
                    };
                }
                Montage.defineProperty(prototype, storageKey, storageDefinition);
            } else {
                if (logger.isError) {
                    logger.error("We have an issue here. The developer should not override the storage value for " + storageKey + ".");
                }
            }
        }
    },

    /**
     Description TODO
     @function
     @param {Property} prototype TODO
     @param {Object} attribute TODO
     */
    addPropertyDefinition:{
        value:function (prototype, attribute) {
            var propertyKey = attribute.name,
                propertyDefinition = null;
            if (!prototype.hasOwnProperty(propertyKey)) {
                propertyDefinition = {
                    get:function () {
                        return this.blueprintGet(propertyKey);
                    },
                    enumerable:true,
                    serializable:false
                };
                if (!attribute.readOnly) {
                    propertyDefinition.set = function (value) {
                        return this.blueprintSet(propertyKey, value);
                    };
                }
                Montage.defineProperty(prototype, propertyKey, propertyDefinition);
            } else {
                if (logger.isDebug) {
                    logger.debug("The developer has already created the property " + propertyKey + " method do nothing.");
                }
            }
        }
    },

    /**
     Description TODO
     @function
     @param {Property} prototype TODO
     @param {Object} attribute TODO
     */
    addPropertyStoredValue:{
        value:function (prototype, attribute) {
            var storedValueKey = attribute.name + "$Storage",
                storedValueDefinition = null;
            if (!prototype.hasOwnProperty(storedValueKey)) {
                if (attribute.isToMany) {
                    storedValueDefinition = {
                        value:[],
                        enumerable:false,
                        serializable:false,
                        distinct:true
                    }
                } else {
                    storedValueDefinition = {
                        value:null,
                        enumerable:false,
                        serializable:false
                    }
                }
                Montage.defineProperty(prototype, storedValueKey, storedValueDefinition);
            } else {
                if (logger.isError) {
                    logger.error("We have an issue here. The developer should not override the stored value for " + storedValueKey + ".");
                }
            }
        }
    },

    /**
     Adds a relationship management methods to the managed object.
     @function
     @param {Property} prototype TODO
     @param {Object} attribute relationship to add
     */
    addAssociation:{
        value:function (prototype, attribute) {
            this.addPropertyStorage(prototype, attribute);
            this.addAssociationDefinition(prototype, attribute);
            this.addPropertyStoredValue(prototype, attribute);
        }
    },


    /**
     Description TODO
     @function
     @param {Property} prototype TODO
     @param {Object} attribute TODO
     */
    addAssociationDefinition:{
        value:function (prototype, attribute) {
            if (attribute.isToMany) {
                this.addToManyAssociationDefinition(prototype, attribute);
            } else {
                this.addToOneAssociationDefinition(prototype, attribute);
            }
         }
    },

    /**
     Description TODO
     @function
     @param {Property} prototype TODO
     @param {Object} attribute TODO
     */
    addToOneAssociationDefinition:{
        value:function (prototype, attribute) {
            var relationshipKey = attribute.name.toCapitalized();
            var key = "addTo" + relationshipKey;
            if (!prototype.hasOwnProperty(key)) {
                Montage.defineProperty(prototype, key, { serializable:false, enumerable:false, value:function () {
                    return null;
                }});
            } else {
                if (logger.isError) {
                    logger.error("We have an issue here. The developer should not override the method " + key + ".");
                }
            }
            key = "removeFrom" + relationshipKey;
            if (!prototype.hasOwnProperty(key)) {
                Montage.defineProperty(prototype, key, { serializable:false, enumerable:false, value:function () {
                    return null;
                }});
            } else {
                if (logger.isError) {
                    logger.error("We have an issue here. The developer should not override the method " + key + ".");
                }
            }
            key = "clear" + relationshipKey;
            if (!prototype.hasOwnProperty(key)) {
                Montage.defineProperty(prototype, key, { serializable:false, enumerable:false, value:function () {
                    return null;
                }});
            } else {
                if (logger.isError) {
                    logger.error("We have an issue here. The developer should not override the method " + key + ".");
                }
            }
        }
    },

    /**
     Description TODO
     @function
     @param {Property} prototype TODO
     @param {Object} attribute TODO
     */
    addToManyAssociationDefinition:{
        value:function (prototype, attribute) {
            var relationshipKey = attribute.name.toCapitalized();
            var key = "addTo" + relationshipKey;
            if (!prototype.hasOwnProperty(key)) {
                Montage.defineProperty(prototype, key, { serializable:false, enumerable:false, value:function () {
                    return null;
                }});
            } else {
                if (logger.isError) {
                    logger.error("We have an issue here. The developer should not override the method " + key + ".");
                }
            }
            key = "removeFrom" + relationshipKey;
            if (!prototype.hasOwnProperty(key)) {
                Montage.defineProperty(prototype, key, { serializable:false, enumerable:false, value:function () {
                    return null;
                }});
            } else {
                if (logger.isError) {
                    logger.error("We have an issue here. The developer should not override the method " + key + ".");
                }
            }
            key = "clear" + relationshipKey;
            if (!prototype.hasOwnProperty(key)) {
                Montage.defineProperty(prototype, key, { serializable:false, enumerable:false, value:function () {
                    return null;
                }});
            } else {
                if (logger.isError) {
                    logger.error("We have an issue here. The developer should not override the method " + key + ".");
                }
            }
        }
    },

    /**
     Adds a derived attribute to the managed object.
     @function
     @param {Property} prototype TODO
     @param {Object} attribute TODO
     */
    addDerivedProperty:{
        value:function (prototype, attribute) {
        }
    },

    /**
     Description TODO
     @function
     @param {Object} attribute TODO
     */
    willRead:{
        value:function (attribute) {
            var storageKey = "_" + attribute.name;
            if (typeof this[storageKey] !== 'undefined') {
                // the property is already resolved nothing to do.
                return;
            }
            if ((typeof this.context !== 'undefined') && (this.context !== null)) {
                this.context.fulfillPropertyForInstance(attribute, this);
            }
        }
    },
    /**
     Description TODO
     @function
     @param {Object} attribute TODO
     @param {Property} value TODO
     */
    willModify:{
        value:function (attribute, value) {
            var storageKey = "_" + attribute.name;
            var previousValue = this[storageKey];
            if ((typeof previousValue === 'undefined') || (previousValue !== value)) {
                // XXX value.addEventListener("change", this._onObjectsChange, false);
                //
                if ((typeof this.context !== 'undefined') && (this.context !== null)) {
                    this.context.willModifyPropertyForInstance(attribute, this, value);
                }
            }
        }
    },

    /**
     Returns the object property manager.<br>
     The object property manager is a unique object in charge of adding properties to objects based on the blueprint.
     @function
     @returns object
     */
    manager:{
        get:function () {
            if (_objectPropertyManager === null) {
                _objectPropertyManager = Object.freeze(ObjectProperty.create().init());
            }
            return _objectPropertyManager;
        }
    }

});