antville/code/HopObject/metadata.js

142 lines
3.1 KiB
JavaScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

// The Antville Project
// http://code.google.com/p/antville
//
// Copyright 20012014 by the Workers of Antville.
//
// Licensed under the Apache License, Version 2.0 (the ``License'');
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an ``AS IS'' BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/**
* @fileOverview Defines metadata extensions of Helmas built-in
* HopObject prototype.
*/
/**
*
* @param {String} name
*/
HopObject.prototype.handleMetadata = function(name) {
this.__defineGetter__(name, function() {
return this.getMetadata(name);
});
this.__defineSetter__(name, function(value) {
return this.setMetadata(name, value);
});
this[name + '_macro'] = function(param) {
return this[name] || null;
};
};
/**
*
* @param {String} name
* @returns {Object}
*/
HopObject.prototype.getMetadata = function(name) {
if (!this.metadata) {
app.log('No metadata collection defined for prototype ' + this.constructor.name);
return name ? null : {};
}
var self = this;
this.metadata.prefetchChildren();
if (!name) {
var result = {};
this.metadata.forEach(function() {
var name = this.name;
if (name) {
result[name] = self.getMetadata(name);
}
});
return result;
}
var meta = this.metadata.get(name);
if (!meta) {
return null;
}
return meta.getValue();
}
/**
*
* @param {String} name
* @param {Object} value
*/
HopObject.prototype.setMetadata = function(name, value) {
if (!this.metadata) {
throw Error('No metadata collection defined for prototype ' + this.constructor.name);
}
if (!name) {
throw Error('Insufficient arguments');
}
if (typeof name === 'object') {
for (var i in name) {
this.setMetadata(i, name[i]);
}
return;
}
var metadata = this.metadata.get(name);
if (metadata) {
metadata.setValue(value);
} else {
metadata = new Metadata(this, name, value);
if (metadata.value !== null) {
// metadata.persist() is not enough or there will be redundant records!
this.metadata.add(metadata);
}
}
return;
}
/**
*
* @param {String} name
*/
HopObject.prototype.deleteMetadata = function(name) {
if (!this.metadata) {
throw Error('No metadata collection defined for prototype ' + this.constructor.name);
}
var self = this;
if (arguments.length === 0) {
HopObject.remove.call(this.metadata);
return;
}
Array.prototype.forEach.call(arguments, function(name) {
var metadata = self.metadata.get(name);
metadata && metadata.remove();
return;
});
return;
}
/**
*
* @param {Object} param
* @param {String} name
*/
HopObject.prototype.metadata_macro = function(param, name) {
var value = this.getMetadata(name);
value && res.write(value);
return;
}