001: /**
002: * JOnAS: Java(TM) Open Application Server
003: * Copyright (C) 1999 Bull S.A.
004: * Contact: jonas-team@objectweb.org
005: *
006: * This library is free software; you can redistribute it and/or
007: * modify it under the terms of the GNU Lesser General Public
008: * License as published by the Free Software Foundation; either
009: * version 2.1 of the License, or any later version.
010: *
011: * This library is distributed in the hope that it will be useful,
012: * but WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * Lesser General Public License for more details.
015: *
016: * You should have received a copy of the GNU Lesser General Public
017: * License along with this library; if not, write to the Free Software
018: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
019: * USA
020: *
021: * Initial developer(s): Philippe Coq
022: * --------------------------------------------------------------------------
023: * $Id: DescriptionGroupDesc.java 4729 2004-05-11 08:07:50Z sauthieg $
024: * --------------------------------------------------------------------------
025: */package org.objectweb.jonas_lib.deployment.api;
026:
027: // SAX imports
028: import org.xml.sax.SAXParseException;
029:
030: /**
031: * This class is used to keep the usage of the contained description related
032: * elements consistent acoross J2EE deployment descriptors.
033: * Elements are "description", "display-name", "icon"
034: * used by application, connector, ejb-jar, webservices.
035: *
036: * @author Philippe Coq
037: *
038: */
039:
040: public abstract class DescriptionGroupDesc implements DescriptionGroup {
041:
042: /**
043: * The description field
044: */
045: protected String description = null;
046:
047: /**
048: * The displayName field
049: */
050: protected String displayName = null;
051:
052: /**
053: * The small-icon field
054: */
055: protected String smallIcon = null;
056:
057: /**
058: * The large-icon field
059: */
060: protected String largeIcon = null;
061:
062: /**
063: * Get the display name of the deployment descriptor.
064: * @return the display name of the deployment descriptor.
065: */
066: public String getDisplayName() {
067: return displayName;
068: }
069:
070: /**
071: * Get the description of the deployment descriptor.
072: * @return the description of the deployment descriptor.
073: */
074: public String getDescription() {
075: return description;
076: }
077:
078: /**
079: * Get the small-icon of the deployment descriptor.
080: * @return the small-icon of the deployment descriptor.
081: */
082: public String getSmallIcon() {
083: return smallIcon;
084: }
085:
086: /**
087: * Get the large-icon of the deployment descriptor.
088: * @return the large-icon of the deployment descriptor.
089: */
090: public String getLargeIcon() {
091: return largeIcon;
092: }
093:
094: /**
095: * Return a String representation of the DeploymentDesc.
096: * @return a String representation of the DeploymentDesc.
097: */
098: public abstract String toString();
099:
100: /**
101: * build a message from SAX Exception in a consistent style, consistent
102: * with emacs compile mode (same as grep, cc, javac, etc).
103: * @param fileName name of the file
104: * @param exception the SAX exception
105: * @param msg the string message
106: * @return a message which is in a consistent style
107: */
108: protected static String getSAXMsg(String fileName,
109: SAXParseException exception, String msg) {
110: String ret = fileName + ":" + exception.getLineNumber() + ":"
111: + exception.getColumnNumber() + ": ";
112: ret += msg;
113: return ret;
114: }
115:
116: }
|