001: // THIS SOFTWARE IS PROVIDED BY SOFTARIS PTY.LTD. AND OTHER METABOSS
002: // CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING,
003: // BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
004: // FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SOFTARIS PTY.LTD.
005: // OR OTHER METABOSS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
006: // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
007: // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
008: // OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
009: // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
010: // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
011: // EVEN IF SOFTARIS PTY.LTD. OR OTHER METABOSS CONTRIBUTORS ARE ADVISED OF THE
012: // POSSIBILITY OF SUCH DAMAGE.
013: //
014: // Copyright 2000-2005 © Softaris Pty.Ltd. All Rights Reserved.
015: package com.metaboss.sdlctools.services.codegenerationstylesheet;
016:
017: /** This structure contains the stylesheet (set of names) pertained to the particular message */
018: public final class STMessageStylesheet {
019: private String mMessageRef = null;
020: private String mNormalisedName = null;
021: private String mNormalisedTypedName = null;
022: private String mClassName = null;
023: private String mPackageName = null;
024: private String mClassFullName = null;
025: private String mProxyClassName = null;
026: private String mProxyTranslatorClassName = null;
027: private String mCataloguePathToTop = null;
028: private String mCataloguePathFromTop = null;
029: private String mNamespaceURI;
030:
031: /** Getter for the unique identifier of the corresponding message */
032: public String getMessageRef() {
033: return mMessageRef;
034: }
035:
036: /** Getter for the normalised name of the element. Normalised name is a
037: * "safe to use in computing" kind of name it must be a single word consisting of
038: * the most basic set of characters (e.g. letters, numbers, underscores)
039: * Note that this name may not be unique in the namespace of the parent element, because
040: * sibling element of another type may have the same name. Consider using NormalisedTypedName to get more unique name */
041: public String getNormalisedName() {
042: return mNormalisedName;
043: }
044:
045: /** Getter for the normalised typed name of the element.
046: * Normalised typed name is similar to the normalised name, but it is derived
047: * from type name and element name which guarantees that this name is unique within parent element scope. */
048: public String getNormalisedTypedName() {
049: return mNormalisedTypedName;
050: }
051:
052: /** Setter for the normalised typed name of the element.
053: * Normalised typed name is similar to the normalised name, but it is derived
054: * from type name and element name which guarantees that this name is unique within parent element scope. */
055: public void setNormalisedTypedName(String pNormalisedTypedName) {
056: mNormalisedTypedName = pNormalisedTypedName;
057: }
058:
059: /** Getter for the name of the class realising this message */
060: public String getClassName() {
061: return mClassName;
062: }
063:
064: /** Getter for the package name of the class realising this message */
065: public String getPackageName() {
066: return mPackageName;
067: }
068:
069: /** Getter for the full (package and name) name of the class realising this message */
070: public String getClassFullName() {
071: return mClassFullName;
072: }
073:
074: /** Getter for the name of the proxy class to this message. Use it to name the CORBA, RMI etc
075: * proxy messages (messages which carry the same data but may use different
076: * datatypes depending on the nature of the technolgy. Note that this proxy class
077: * may reside in any package as chosen by generator (in fact there will
078: * most probably be more than one implementation each in different package) */
079: public String getProxyClassName() {
080: return mProxyClassName;
081: }
082:
083: /** Getter for the name of the proxy translator class to this message. Use it to name the CORBA, RMI etc
084: * proxy translation helpers (classes which help copying the data between
085: * actual messages and their proxies. Note that this proxy translator class
086: * may reside in any package as chosen by generator (in fact there will
087: * most probably be more than one implementation each in different package) */
088: public String getProxyTranslatorClassName() {
089: return mProxyTranslatorClassName;
090: }
091:
092: /** Getter for the relative path to the top from the catalogue where information related to this object is located.
093: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
094: * It is used for things like help files, documentation directory tree etc. */
095: public String getCataloguePathToTop() {
096: return mCataloguePathToTop;
097: }
098:
099: /** Getter for the relative path from the top to the catalogue where information related to this object is located.
100: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
101: * It is used for things like help files, documentation directory tree etc. */
102: public String getCataloguePathFromTop() {
103: return mCataloguePathFromTop;
104: }
105:
106: /** Setter for the unique identifier of the corresponding message */
107: public void setMessageRef(String pMessageRef) {
108: mMessageRef = pMessageRef;
109: }
110:
111: /** Setter for the normalised name of the element. Normalised name is a
112: * "safe to use in computing" kind of name it must be a single word consisting of
113: * the most basic set of characters (e.g. letters, numbers, underscores).
114: * Note that this name may not be unique in the namespace of the parent element, because
115: * sibling element of another type may have the same name. Consider using NormalisedTypedName to get more unique name */
116: public void setNormalisedName(String pNormalisedName) {
117: mNormalisedName = pNormalisedName;
118: }
119:
120: /** Setter for the name of the class realising this message */
121: public void setClassName(String pClassName) {
122: mClassName = pClassName;
123: }
124:
125: /** Setter for the package name of the class realising this message */
126: public void setPackageName(String pPackageName) {
127: mPackageName = pPackageName;
128: }
129:
130: /** Setter for the full (package and name) name of the class realising this message */
131: public void setClassFullName(String pClassFullName) {
132: mClassFullName = pClassFullName;
133: }
134:
135: /** Setter for the name of the proxy class to this message. Use it to name the CORBA, RMI etc
136: * proxy messages (messages which carry the same data but may use different
137: * datatypes depending on the nature of the technolgy. Note that this proxy class
138: * may reside in any package as chosen by generator (in fact there will
139: * most probably be more than one implementation each in different package) */
140: public void setProxyClassName(String pProxyClassName) {
141: mProxyClassName = pProxyClassName;
142: }
143:
144: /** Setter for the name of the proxy translator class to this message. Use it to name the CORBA, RMI etc
145: * proxy translation helpers (classes which help copying the data between
146: * actual messages and their proxies. Note that this proxy translator class
147: * may reside in any package as chosen by generator (in fact there will
148: * most probably be more than one implementation each in different package) */
149: public void setProxyTranslatorClassName(
150: String pProxyTranslatorClassName) {
151: mProxyTranslatorClassName = pProxyTranslatorClassName;
152: }
153:
154: /** Setter for the relative path to the top from the catalogue where information related to this object is located.
155: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
156: * It is used for things like help files, documentation directory tree etc. */
157: public void setCataloguePathToTop(String pCataloguePathToTop) {
158: mCataloguePathToTop = pCataloguePathToTop;
159: }
160:
161: /** Setter for the relative path from the top to the catalogue where information related to this object is located
162: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
163: * It is used for things like help files, documentation directory tree etc. */
164: public void setCataloguePathFromTop(String pCataloguePathFromTop) {
165: mCataloguePathFromTop = pCataloguePathFromTop;
166: }
167:
168: /** Getter for the standard xml schema namespace */
169: public String getNamespaceURI() {
170: return mNamespaceURI;
171: }
172:
173: /** Setter for the generic xml name space URI */
174: public void setNamespaceURI(String pNamespaceURI) {
175: mNamespaceURI = pNamespaceURI;
176: }
177: }
|