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 service */
018: public final class STServiceStylesheet {
019: private String mServiceRef = null;
020: private String mNormalisedName = null;
021: private String mNormalisedTypedName = null;
022: private String mImplementationClassName = null;
023: private String mImplementationFactoryClassName = null;
024: private String mAdapterRootPackageName;
025: private String mAdapterRootPackageDir;
026: private String mAdapterClassName = null;
027: private String mInterfaceName = null;
028: private String mInterfaceFullName = null;
029: private String mPackageName = null;
030: private String mNamespaceURI;
031: private String mGeneratedImplementationBasePackageName = null;
032: private String mGeneratedImplementationNamePrefix = null;
033: private String mGeneratedImplementationNameSuffix = null;
034: private String mGeneratedProxyBasePackageName = null;
035: private String mGeneratedProxyRefSuffix = null;
036: private String mCataloguePathToTop = null;
037: private String mCataloguePathFromTop = null;
038:
039: /** Getter for the unique identifier of the corresponding service */
040: public String getServiceRef() {
041: return mServiceRef;
042: }
043:
044: /** Getter for the normalised name of the element. Normalised name is a
045: * "safe to use in computing" kind of name it must be a single word consisting of
046: * the most basic set of characters (e.g. letters, numbers, underscores).
047: * Note that this name may not be unique in the namespace of the parent element, because
048: * sibling element of another type may have the same name. Consider using NormalisedTypedName to get more unique name */
049: public String getNormalisedName() {
050: return mNormalisedName;
051: }
052:
053: /** Getter for the name of the package where interface realising this service resides */
054: public String getPackageName() {
055: return mPackageName;
056: }
057:
058: /** Getter for the name of the interface realising this service */
059: public String getInterfaceName() {
060: return mInterfaceName;
061: }
062:
063: /** Getter for the standard xml schema namespace */
064: public String getNamespaceURI() {
065: return mNamespaceURI;
066: }
067:
068: /** Getter for the full name of the interface realising this service */
069: public String getInterfaceFullName() {
070: return mInterfaceFullName;
071: }
072:
073: /** Getter for the name of the class, which is an adaptor / bridge between this service
074: * and some other technology. Note that this class may reside in any package as chosen by generator
075: * (in fact there will most probably be more than one implementation each in different package) */
076: public String getAdapterClassName() {
077: return mAdapterClassName;
078: }
079:
080: /** Getter for the name of the package for the adapters of the service */
081: public String getAdaptersRootPackageName() {
082: return mAdapterRootPackageName;
083: }
084:
085: /** Getter for the name of the directory for the adapters of the service.
086: * Directory is formed similar to package, but directory separators are used intead of dots */
087: public String getAdapterRootPackageDir() {
088: return mAdapterRootPackageDir;
089: }
090:
091: /** Getter for the name of the class implementing this service. Note that this class
092: * may reside in any package as chosen by generator (in fact there will
093: * most probably be more than one implementation each in different package) */
094: public String getImplementationClassName() {
095: return mImplementationClassName;
096: }
097:
098: /** Getter for the name of the object factory class instantiating this service Note that this class
099: * may reside in any package as chosen by generator (in fact there will
100: * most probably be more than one implementation each in different package) */
101: public String getImplementationFactoryClassName() {
102: return mImplementationFactoryClassName;
103: }
104:
105: /** Getter for the name of the root package under which generated service implementations are located.
106: * If service has the one and only one possible default implementation - it can go in this package itself.
107: * All other implementations must be in the sub packages of this package.
108: * For example if this setting equals com.metaboss.generatedimpl than the simulator implementation would
109: * be in the package com.metaboss.generatedimpl.simulator */
110: public String getGeneratedImplementationBasePackageName() {
111: return mGeneratedImplementationBasePackageName;
112: }
113:
114: /** Getter for the suffix to use when generating the name of the generated implementation.
115: * For example if this setting equals "_Autogenerated" than the Simulator implementation would
116: * have ref <Enterprise>.<System>.<Servicemodule>.<Service>.Simulator_Autogenerated */
117: public String getGeneratedImplementationNameSuffix() {
118: return mGeneratedImplementationNameSuffix;
119: }
120:
121: /** Getter for the suffix to use when generating the name of the generated implementation.
122: * For example if this setting equals "Autogenerated_" than the Simulator implementation would
123: * have ref <Enterprise>.<System>.<Servicemodule>.<Service>.Autogenerated_Simulator */
124: public String getGeneratedImplementationNamePrefix() {
125: return mGeneratedImplementationNamePrefix;
126: }
127:
128: /** Getter for the name of the root package under which generated service proxies are located.
129: * If service has the one and only one possible default proxy (very unlikely !!!) - it can go in this package itself.
130: * All other proxies must be in the sub packages of this package.
131: * For example if this setting equals com.metaboss.generatedproxy than the logging proxy would
132: * be in the package com.metaboss.generatedproxy.logging */
133: public String getGeneratedProxyBasePackageName() {
134: return mGeneratedProxyBasePackageName;
135: }
136:
137: /** Getter for the suffix to use when creating the reference of the generated proxy.
138: * For example if this setting equals "_Autogenerated" than the Logging proxy would
139: * have ref <Enterprise>.<System>.<Servicemodule>.<Service>.Logging_Autogenerated */
140: public String getGeneratedProxyRefSuffix() {
141: return mGeneratedProxyRefSuffix;
142: }
143:
144: /** Getter for the relative path to the top from the catalogue where information related to this object is located.
145: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
146: * It is used for things like help files, documentation directory tree etc. */
147: public String getCataloguePathToTop() {
148: return mCataloguePathToTop;
149: }
150:
151: /** Getter for the relative path from the top to the catalogue where information related to this object is located.
152: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
153: * It is used for things like help files, documentation directory tree etc. */
154: public String getCataloguePathFromTop() {
155: return mCataloguePathFromTop;
156: }
157:
158: /** Setter for the name of the package where interface realising this service is residing */
159: public void setPackageName(String pPackageName) {
160: mPackageName = pPackageName;
161: }
162:
163: /** Setter for the normalised name of the element. Normalised name is a
164: * "safe to use in computing" kind of name it must be a single word consisting of
165: * the most basic set of characters (e.g. letters, numbers, underscores).
166: * Note that this name may not be unique in the namespace of the parent element, because
167: * sibling element of another type may have the same name. Consider using NormalisedTypedName to get more unique name */
168: public void setNormalisedName(String pNormalisedName) {
169: mNormalisedName = pNormalisedName;
170: }
171:
172: /** Getter for the normalised typed name of the element.
173: * Normalised typed name is similar to the normalised name, but it is derived
174: * from type name and element name which guarantees that this name is unique within parent element scope. */
175: public String getNormalisedTypedName() {
176: return mNormalisedTypedName;
177: }
178:
179: /** Setter for the normalised typed name of the element.
180: * Normalised typed name is similar to the normalised name, but it is derived
181: * from type name and element name which guarantees that this name is unique within parent element scope. */
182: public void setNormalisedTypedName(String pNormalisedTypedName) {
183: mNormalisedTypedName = pNormalisedTypedName;
184: }
185:
186: /** Setter for the name of the interface realising this service */
187: public void setInterfaceName(String pInterfaceName) {
188: mInterfaceName = pInterfaceName;
189: }
190:
191: /** Setter for the generic xml name space URI */
192: public void setNamespaceURI(String pNamespaceURI) {
193: mNamespaceURI = pNamespaceURI;
194: }
195:
196: /** Setter for the full name of the interface realising this service */
197: public void setInterfaceFullName(String pInterfaceFullName) {
198: mInterfaceFullName = pInterfaceFullName;
199: }
200:
201: /** Setter for the unique identifier of the corresponding service */
202: public void setServiceRef(String pServiceRef) {
203: mServiceRef = pServiceRef;
204: }
205:
206: /** Setter for the name of the package for the adapters of the service */
207: public void setAdaptersRootPackageName(
208: String pAdapterRootPackageName) {
209: mAdapterRootPackageName = pAdapterRootPackageName;
210: }
211:
212: /** Setter for the name of the directory for the adapters of the service
213: * Directory is formed similar to package, but directory separators are used intead of dots */
214: public void setAdapterRootPackageDir(String pAdapterRootPackageDir) {
215: mAdapterRootPackageDir = pAdapterRootPackageDir;
216: }
217:
218: /** Setter for the name of the class, which is an adaptor / bridge between this service
219: * and some other technology. Note that this class may reside in any package as chosen by generator
220: * (in fact there will most probably be more than one implementation each in different package) */
221: public void setAdapterClassName(String pAdapterClassName) {
222: mAdapterClassName = pAdapterClassName;
223: }
224:
225: /** Setter for the name of the class implementing this service. Note that this class
226: * may reside in any package as chosen by generator (in fact there will
227: * most probably be more than one implementation each in different package) */
228: public void setImplementationClassName(
229: String pImplementationClassName) {
230: mImplementationClassName = pImplementationClassName;
231: }
232:
233: /** Setter for the name of the object factory class instantiating this service Note that this class
234: * may reside in any package as chosen by generator (in fact there will
235: * most probably be more than one implementation each in different package) */
236: public void setImplementationFactoryClassName(
237: String pImplementationFactoryClassName) {
238: mImplementationFactoryClassName = pImplementationFactoryClassName;
239: }
240:
241: /** Setter for the name of the root package under which generated service implementations are located.
242: * If service has the one and only one possible default implementation - it can go in this package itself.
243: * All other implementations must be in the sub packages of this package.
244: * For example if this setting equals com.metaboss.generatedimpl than the simulator implementation would
245: * be in the package com.metaboss.generatedimpl.simulator */
246: public void setGeneratedImplementationBasePackageName(
247: String pGeneratedImplementationBasePackageName) {
248: mGeneratedImplementationBasePackageName = pGeneratedImplementationBasePackageName;
249: }
250:
251: /** Setter for the suffix to use when creating the name of the generated implementation.
252: * For example if this setting equals "_Autogenerated" than the Simulator implementation would
253: * have ref <Enterprise>.<System>.<Servicemodule>.<Service>.Simulator_Autogenerated */
254: public void setGeneratedImplementationNameSuffix(
255: String pGeneratedImplementationNameSuffix) {
256: mGeneratedImplementationNameSuffix = pGeneratedImplementationNameSuffix;
257: }
258:
259: /** Setter for the prefix to use when creating the name of the generated implementation.
260: * For example if this setting equals "Autogenerated_" than the Simulator implementation would
261: * have ref <Enterprise>.<System>.<Servicemodule>.<Service>.Autogenerated_Simulator */
262: public void setGeneratedImplementationNamePrefix(
263: String pGeneratedImplementationNamePrefix) {
264: mGeneratedImplementationNamePrefix = pGeneratedImplementationNamePrefix;
265: }
266:
267: /** Setter for the name of the root package under which generated service proxies are located.
268: * If service has the one and only one possible default proxy (very unlikely !!!) - it can go in this package itself.
269: * All other proxies must be in the sub packages of this package.
270: * For example if this setting equals com.metaboss.generatedproxy than the logging proxy would
271: * be in the package com.metaboss.generatedproxy.logging */
272: public void setGeneratedProxyBasePackageName(
273: String pGeneratedProxyBasePackageName) {
274: mGeneratedProxyBasePackageName = pGeneratedProxyBasePackageName;
275: }
276:
277: /** Setter for the suffix to use when creating the reference of the generated proxy.
278: * For example if this setting equals "_Autogenerated" than the Logging proxy would
279: * have ref <Enterprise>.<System>.<Servicemodule>.<Service>.Logging_Autogenerated */
280: public void setGeneratedProxyRefSuffix(
281: String pGeneratedProxyRefSuffix) {
282: mGeneratedProxyRefSuffix = pGeneratedProxyRefSuffix;
283: }
284:
285: /** Setter for the relative path to the top from the catalogue where information related to this object is located.
286: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
287: * It is used for things like help files, documentation directory tree etc. */
288: public void setCataloguePathToTop(String pCataloguePathToTop) {
289: mCataloguePathToTop = pCataloguePathToTop;
290: }
291:
292: /** Setter for the relative path from the top to the catalogue where information related to this object is located
293: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
294: * It is used for things like help files, documentation directory tree etc. */
295: public void setCataloguePathFromTop(String pCataloguePathFromTop) {
296: mCataloguePathFromTop = pCataloguePathFromTop;
297: }
298: }
|