001: /*--
002:
003: Copyright (C) 2002-2005 Adrian Price.
004: All rights reserved.
005:
006: Redistribution and use in source and binary forms, with or without
007: modification, are permitted provided that the following conditions
008: are met:
009:
010: 1. Redistributions of source code must retain the above copyright
011: notice, this list of conditions, and the following disclaimer.
012:
013: 2. Redistributions in binary form must reproduce the above copyright
014: notice, this list of conditions, and the disclaimer that follows
015: these conditions in the documentation and/or other materials
016: provided with the distribution.
017:
018: 3. The names "OBE" and "Open Business Engine" must not be used to
019: endorse or promote products derived from this software without prior
020: written permission. For written permission, please contact
021: adrianprice@sourceforge.net.
022:
023: 4. Products derived from this software may not be called "OBE" or
024: "Open Business Engine", nor may "OBE" or "Open Business Engine"
025: appear in their name, without prior written permission from
026: Adrian Price (adrianprice@users.sourceforge.net).
027:
028: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
029: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
030: OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
031: DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
032: INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
033: (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
034: SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
035: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
036: STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
037: IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
038: POSSIBILITY OF SUCH DAMAGE.
039:
040: For more information on OBE, please see
041: <http://obe.sourceforge.net/>.
042:
043: */
044:
045: package org.obe.client.api.repository;
046:
047: /**
048: * Describes a user-defined evaluator call. Different evaluator types extend
049: * this class with the additional meta data required to instantiate the
050: * evaluator implementation itself.
051: *
052: * @author Adrian Price
053: */
054: public abstract class EvaluatorMetaData extends AbstractMetaData {
055: private static final long serialVersionUID = -429157659267364196L;
056:
057: private String _grammar;
058:
059: // TODO: figure out how to handle evaluator signature discovery & meta-data.
060:
061: protected EvaluatorMetaData() {
062: }
063:
064: /**
065: * Constructs evaluator meta-data.
066: *
067: * @param id The evaluator ID.
068: * @param displayName The display name.
069: * @param description Textual description of this evaluator.
070: * @param docUrl URL for documentation.
071: * @param author Author's name.
072: * @param threadsafe
073: * @param grammar Url of specification for script language grammar.
074: */
075: protected EvaluatorMetaData(String id, String displayName,
076: String description, String docUrl, String author,
077: boolean threadsafe, String grammar) {
078:
079: super (id, displayName, description, docUrl, author, threadsafe);
080: _grammar = grammar;
081: }
082:
083: public String getGrammar() {
084: return _grammar != null ? _grammar : _type == null
085: || !allowInheritance ? null
086: : ((EvaluatorMetaData) _type).getGrammar();
087: }
088:
089: public void setGrammar(String grammar) {
090: _grammar = grammar;
091: }
092:
093: public String toString() {
094: String className = getClass().getName();
095: className = className.substring(className.lastIndexOf('.') + 1);
096: return className + "[_id='" + _id + '\'' + ",_displayName='"
097: + _displayName + '\'' + ",_description='"
098: + _description + '\'' + ",_docUrl='" + _docUrl + '\''
099: + ",_author='" + _author + '\'' + ",_grammar='"
100: + _grammar + '\'' + ",_type=" + _type + ']';
101: }
102: }
|