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 event subscription */
018: public final class STEventSubscriptionStylesheet {
019: private String mEventSubscriptionRef = 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 mSubscriberInterfaceName = null;
030: private String mSubscriberSubscriptionInitiatedHandlerName = null;
031: private String mSubscriberSubscriptionInterruptedHandlerName = null;
032: private String mSubscriberSubscriptionRestoredHandlerName = null;
033: private String mSubscriberSubscriptionTerminatedHandlerName = null;
034: private String mSubscriberAdapterClassName = null;
035: private String mPackageName = null;
036: private String mNamespaceURI;
037: private String mGeneratedImplementationBasePackageName = null;
038: private String mGeneratedImplementationNamePrefix = null;
039: private String mGeneratedImplementationNameSuffix = null;
040: private String mGeneratedProxyBasePackageName = null;
041: private String mGeneratedProxyRefSuffix = null;
042: private String mCataloguePathToTop = null;
043: private String mCataloguePathFromTop = null;
044: private String mPublisherPackageName = null;
045: private String mPublisherSynchroniserInterfaceName = null;
046: private String mPublisherSynchroniserInterfaceFullName = null;
047: private String mPublisherSynchroniserImplementationClassName = null;
048: private String mPublisherSynchroniserImplementationFactoryClassName = null;
049: private String mPublisherEventSinkInterfaceName = null;
050: private String mPublisherEventSinkInterfaceFullName = null;
051: private String mPublisherEventSinkImplementationClassName = null;
052: private String mPublisherEventSinkImplementationFactoryClassName = null;
053:
054: /** Getter for the unique identifier of the corresponding event subscription */
055: public String getEventSubscriptionRef() {
056: return mEventSubscriptionRef;
057: }
058:
059: /** Getter for the normalised name of the element. Normalised name is a
060: * "safe to use in computing" kind of name it must be a single word consisting of
061: * the most basic set of characters (e.g. letters, numbers, underscores).
062: * Note that this name may not be unique in the namespace of the parent element, because
063: * sibling element of another type may have the same name. Consider using NormalisedTypedName to get more unique name */
064: public String getNormalisedName() {
065: return mNormalisedName;
066: }
067:
068: /** Getter for the name of the package where interface realising this event subscription resides */
069: public String getPackageName() {
070: return mPackageName;
071: }
072:
073: /** Getter for the name of the interface realising this event subscription */
074: public String getInterfaceName() {
075: return mInterfaceName;
076: }
077:
078: /** Getter for the name of the interface realising this event subscriber */
079: public String getSubscriberInterfaceName() {
080: return mSubscriberInterfaceName;
081: }
082:
083: /** Getter for the name of the adapter class realising this event subscriber adapter */
084: public String getSubscriberAdapterClassName() {
085: return mSubscriberAdapterClassName;
086: }
087:
088: /** Setter for the name of the adapter class realising this event subscriber adapter */
089: public void setSubscriberAdapterClassName(
090: String pSubscriberAdapterClassName) {
091: mSubscriberAdapterClassName = pSubscriberAdapterClassName;
092: }
093:
094: /** Getter for the standard xml schema namespace */
095: public String getNamespaceURI() {
096: return mNamespaceURI;
097: }
098:
099: /** Getter for the full name of the interface realising this event subscription */
100: public String getInterfaceFullName() {
101: return mInterfaceFullName;
102: }
103:
104: /** Getter for the name of the class, which is an adaptor / bridge between this event subscription
105: * and some other technology. Note that this class may reside in any package as chosen by generator
106: * (in fact there will most probably be more than one implementation each in different package) */
107: public String getAdapterClassName() {
108: return mAdapterClassName;
109: }
110:
111: /** Getter for the name of the package for the adapters of the event subscription */
112: public String getAdaptersRootPackageName() {
113: return mAdapterRootPackageName;
114: }
115:
116: /** Getter for the name of the directory for the adapters of the event subscription.
117: * Directory is formed similar to package, but directory separators are used intead of dots */
118: public String getAdapterRootPackageDir() {
119: return mAdapterRootPackageDir;
120: }
121:
122: /** Getter for the name of the class implementing this event subscription. Note that this class
123: * may reside in any package as chosen by generator (in fact there will
124: * most probably be more than one implementation each in different package) */
125: public String getImplementationClassName() {
126: return mImplementationClassName;
127: }
128:
129: /** Getter for the name of the object factory class instantiating this event subscription Note that this class
130: * may reside in any package as chosen by generator (in fact there will
131: * most probably be more than one implementation each in different package) */
132: public String getImplementationFactoryClassName() {
133: return mImplementationFactoryClassName;
134: }
135:
136: /** Getter for the name of the root package under which generated event subscription implementations are located.
137: * If event subscription has the one and only one possible default implementation - it can go in this package itself.
138: * All other implementations must be in the sub packages of this package.
139: * For example if this setting equals com.metaboss.generatedimpl than the simulator implementation would
140: * be in the package com.metaboss.generatedimpl.simulator */
141: public String getGeneratedImplementationBasePackageName() {
142: return mGeneratedImplementationBasePackageName;
143: }
144:
145: /** Getter for the suffix to use when generating the name of the generated implementation.
146: * For example if this setting equals "_Autogenerated" than the Simulator implementation would
147: * have ref <Enterprise>.<System>.<Servicemodule>.<Service>.Simulator_Autogenerated */
148: public String getGeneratedImplementationNameSuffix() {
149: return mGeneratedImplementationNameSuffix;
150: }
151:
152: /** Getter for the suffix to use when generating the name of the generated implementation.
153: * For example if this setting equals "Autogenerated_" than the Simulator implementation would
154: * have ref <Enterprise>.<System>.<Servicemodule>.<Service>.Autogenerated_Simulator */
155: public String getGeneratedImplementationNamePrefix() {
156: return mGeneratedImplementationNamePrefix;
157: }
158:
159: /** Getter for the name of the root package under which generated event subscription proxies are located.
160: * If event subscription has the one and only one possible default proxy (very unlikely !!!) - it can go in this package itself.
161: * All other proxies must be in the sub packages of this package.
162: * For example if this setting equals com.metaboss.generatedproxy than the logging proxy would
163: * be in the package com.metaboss.generatedproxy.logging */
164: public String getGeneratedProxyBasePackageName() {
165: return mGeneratedProxyBasePackageName;
166: }
167:
168: /** Getter for the suffix to use when creating the reference of the generated proxy.
169: * For example if this setting equals "_Autogenerated" than the Logging proxy would
170: * have ref <Enterprise>.<System>.<Servicemodule>.<Service>.Logging_Autogenerated */
171: public String getGeneratedProxyRefSuffix() {
172: return mGeneratedProxyRefSuffix;
173: }
174:
175: /** Getter for the relative path to the top from the catalogue where information related to this object is located.
176: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
177: * It is used for things like help files, documentation directory tree etc. */
178: public String getCataloguePathToTop() {
179: return mCataloguePathToTop;
180: }
181:
182: /** Getter for the relative path from the top to the catalogue where information related to this object is located.
183: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
184: * It is used for things like help files, documentation directory tree etc. */
185: public String getCataloguePathFromTop() {
186: return mCataloguePathFromTop;
187: }
188:
189: /** Setter for the name of the package where interface realising this event subscription is residing */
190: public void setPackageName(String pPackageName) {
191: mPackageName = pPackageName;
192: }
193:
194: /** Setter for the normalised name of the element. Normalised name is a
195: * "safe to use in computing" kind of name it must be a single word consisting of
196: * the most basic set of characters (e.g. letters, numbers, underscores).
197: * Note that this name may not be unique in the namespace of the parent element, because
198: * sibling element of another type may have the same name. Consider using NormalisedTypedName to get more unique name */
199: public void setNormalisedName(String pNormalisedName) {
200: mNormalisedName = pNormalisedName;
201: }
202:
203: /** Getter for the normalised typed name of the element.
204: * Normalised typed name is similar to the normalised name, but it is derived
205: * from type name and element name which guarantees that this name is unique within parent element scope. */
206: public String getNormalisedTypedName() {
207: return mNormalisedTypedName;
208: }
209:
210: /** Setter for the normalised typed name of the element.
211: * Normalised typed name is similar to the normalised name, but it is derived
212: * from type name and element name which guarantees that this name is unique within parent element scope. */
213: public void setNormalisedTypedName(String pNormalisedTypedName) {
214: mNormalisedTypedName = pNormalisedTypedName;
215: }
216:
217: /** Setter for the name of the interface realising this event subscription */
218: public void setInterfaceName(String pInterfaceName) {
219: mInterfaceName = pInterfaceName;
220: }
221:
222: /** Setter for the generic xml name space URI */
223: public void setNamespaceURI(String pNamespaceURI) {
224: mNamespaceURI = pNamespaceURI;
225: }
226:
227: /** Setter for the full name of the interface realising this event subscription */
228: public void setInterfaceFullName(String pInterfaceFullName) {
229: mInterfaceFullName = pInterfaceFullName;
230: }
231:
232: /** Setter for the name of the interface realising this event subscriber */
233: public void setSubscriberInterfaceName(
234: String pSubscriberInterfaceName) {
235: mSubscriberInterfaceName = pSubscriberInterfaceName;
236: }
237:
238: /** Setter for the unique identifier of the corresponding event subscription */
239: public void setEventSubscriptionRef(String pEventSubscriptionRef) {
240: mEventSubscriptionRef = pEventSubscriptionRef;
241: }
242:
243: /** Setter for the name of the package for the adapters of the event subscription */
244: public void setAdaptersRootPackageName(
245: String pAdapterRootPackageName) {
246: mAdapterRootPackageName = pAdapterRootPackageName;
247: }
248:
249: /** Setter for the name of the directory for the adapters of the event subscription
250: * Directory is formed similar to package, but directory separators are used intead of dots */
251: public void setAdapterRootPackageDir(String pAdapterRootPackageDir) {
252: mAdapterRootPackageDir = pAdapterRootPackageDir;
253: }
254:
255: /** Setter for the name of the class, which is an adaptor / bridge between this event subscription
256: * and some other technology. Note that this class may reside in any package as chosen by generator
257: * (in fact there will most probably be more than one implementation each in different package) */
258: public void setAdapterClassName(String pAdapterClassName) {
259: mAdapterClassName = pAdapterClassName;
260: }
261:
262: /** Setter for the name of the class implementing this event subscription. Note that this class
263: * may reside in any package as chosen by generator (in fact there will
264: * most probably be more than one implementation each in different package) */
265: public void setImplementationClassName(
266: String pImplementationClassName) {
267: mImplementationClassName = pImplementationClassName;
268: }
269:
270: /** Setter for the name of the object factory class instantiating this event subscription Note that this class
271: * may reside in any package as chosen by generator (in fact there will
272: * most probably be more than one implementation each in different package) */
273: public void setImplementationFactoryClassName(
274: String pImplementationFactoryClassName) {
275: mImplementationFactoryClassName = pImplementationFactoryClassName;
276: }
277:
278: /** Setter for the name of the root package under which generated event subscription implementations are located.
279: * If event subscription has the one and only one possible default implementation - it can go in this package itself.
280: * All other implementations must be in the sub packages of this package.
281: * For example if this setting equals com.metaboss.generatedimpl than the simulator implementation would
282: * be in the package com.metaboss.generatedimpl.simulator */
283: public void setGeneratedImplementationBasePackageName(
284: String pGeneratedImplementationBasePackageName) {
285: mGeneratedImplementationBasePackageName = pGeneratedImplementationBasePackageName;
286: }
287:
288: /** Setter for the suffix to use when creating the name of the generated implementation.
289: * For example if this setting equals "_Autogenerated" than the Simulator implementation would
290: * have ref <Enterprise>.<System>.<Servicemodule>.<Service>.Simulator_Autogenerated */
291: public void setGeneratedImplementationNameSuffix(
292: String pGeneratedImplementationNameSuffix) {
293: mGeneratedImplementationNameSuffix = pGeneratedImplementationNameSuffix;
294: }
295:
296: /** Setter for the prefix to use when creating the name of the generated implementation.
297: * For example if this setting equals "Autogenerated_" than the Simulator implementation would
298: * have ref <Enterprise>.<System>.<Servicemodule>.<Service>.Autogenerated_Simulator */
299: public void setGeneratedImplementationNamePrefix(
300: String pGeneratedImplementationNamePrefix) {
301: mGeneratedImplementationNamePrefix = pGeneratedImplementationNamePrefix;
302: }
303:
304: /** Setter for the name of the root package under which generated event subscription proxies are located.
305: * If event subscription has the one and only one possible default proxy (very unlikely !!!) - it can go in this package itself.
306: * All other proxies must be in the sub packages of this package.
307: * For example if this setting equals com.metaboss.generatedproxy than the logging proxy would
308: * be in the package com.metaboss.generatedproxy.logging */
309: public void setGeneratedProxyBasePackageName(
310: String pGeneratedProxyBasePackageName) {
311: mGeneratedProxyBasePackageName = pGeneratedProxyBasePackageName;
312: }
313:
314: /** Setter for the suffix to use when creating the reference of the generated proxy.
315: * For example if this setting equals "_Autogenerated" than the Logging proxy would
316: * have ref <Enterprise>.<System>.<Servicemodule>.<Service>.Logging_Autogenerated */
317: public void setGeneratedProxyRefSuffix(
318: String pGeneratedProxyRefSuffix) {
319: mGeneratedProxyRefSuffix = pGeneratedProxyRefSuffix;
320: }
321:
322: /** Setter for the relative path to the top from the catalogue where information related to this object is located.
323: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
324: * It is used for things like help files, documentation directory tree etc. */
325: public void setCataloguePathToTop(String pCataloguePathToTop) {
326: mCataloguePathToTop = pCataloguePathToTop;
327: }
328:
329: /** Setter for the relative path from the top to the catalogue where information related to this object is located
330: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
331: * It is used for things like help files, documentation directory tree etc. */
332: public void setCataloguePathFromTop(String pCataloguePathFromTop) {
333: mCataloguePathFromTop = pCataloguePathFromTop;
334: }
335:
336: /** Getter for the name of the package where pipeline interfaces realising this event subscription resides */
337: public String getPublisherPackageName() {
338: return mPublisherPackageName;
339: }
340:
341: /** Setter for the name of the package where pipeline interfaces realising this event subscription resides */
342: public void setPublisherPackageName(String pPublisherPackageName) {
343: mPublisherPackageName = pPublisherPackageName;
344: }
345:
346: /** Getter for the name of the interface implementing event sink for this event subscription resides */
347: public String getPublisherEventSinkInterfaceName() {
348: return mPublisherEventSinkInterfaceName;
349: }
350:
351: /** Setter for the name of the interface implementing event sink for this event subscription resides */
352: public void setPublisherEventSinkInterfaceName(
353: String pPublisherEventSinkInterfaceName) {
354: mPublisherEventSinkInterfaceName = pPublisherEventSinkInterfaceName;
355: }
356:
357: /** Getter for the full name of the interface implementing event sink for this event subscription resides */
358: public String getPublisherEventSinkInterfaceFullName() {
359: return mPublisherEventSinkInterfaceFullName;
360: }
361:
362: /** Setter for the name of the interface implementing event sink for this event subscription resides */
363: public void setPublisherEventSinkInterfaceFullName(
364: String pPublisherEventSinkInterfaceFullName) {
365: mPublisherEventSinkInterfaceFullName = pPublisherEventSinkInterfaceFullName;
366: }
367:
368: /** Getter for the name of the interface implementing event synchroniser for this event subscription resides */
369: public String getPublisherSynchroniserInterfaceName() {
370: return mPublisherSynchroniserInterfaceName;
371: }
372:
373: /** Setter for the name of the interface implementing event synchroniser for this event subscription resides */
374: public void setPublisherSynchroniserInterfaceName(
375: String pPublisherSynchroniserInterfaceName) {
376: mPublisherSynchroniserInterfaceName = pPublisherSynchroniserInterfaceName;
377: }
378:
379: /** Getter for the full name of the interface implementing event synchroniser for this event subscription resides */
380: public String getPublisherSynchroniserInterfaceFullName() {
381: return mPublisherSynchroniserInterfaceFullName;
382: }
383:
384: /** Setter for the name of the interface implementing event synchroniser for this event subscription resides */
385: public void setPublisherSynchroniserInterfaceFullName(
386: String pPublisherSynchroniserInterfaceFullName) {
387: mPublisherSynchroniserInterfaceFullName = pPublisherSynchroniserInterfaceFullName;
388: }
389:
390: /** Getter for the name of the SubscriptionInitiated handler method inside the Subscriber */
391: public String getSubscriberSubscriptionInitiatedHandlerName() {
392: return mSubscriberSubscriptionInitiatedHandlerName;
393: }
394:
395: /** Setter for the name of the SubscriptionInitiated handler method inside the Subscriber */
396: public void setSubscriberSubscriptionInitiatedHandlerName(
397: String pSubscriberSubscriptionInitiatedHandlerName) {
398: mSubscriberSubscriptionInitiatedHandlerName = pSubscriberSubscriptionInitiatedHandlerName;
399: }
400:
401: /** Getter for the name of the SubscriptionInterrupted handler method inside the Subscriber */
402: public String getSubscriberSubscriptionInterruptedHandlerName() {
403: return mSubscriberSubscriptionInterruptedHandlerName;
404: }
405:
406: /** Setter for the name of the SubscriptionInterrupted handler method inside the Subscriber */
407: public void setSubscriberSubscriptionInterruptedHandlerName(
408: String pSubscriberSubscriptionInterruptedHandlerName) {
409: mSubscriberSubscriptionInterruptedHandlerName = pSubscriberSubscriptionInterruptedHandlerName;
410: }
411:
412: /** Getter for the name of the SubscriptionRestored handler method inside the Subscriber */
413: public String getSubscriberSubscriptionRestoredHandlerName() {
414: return mSubscriberSubscriptionRestoredHandlerName;
415: }
416:
417: /** Setter for the name of the SubscriptionRestored handler method inside the Subscriber */
418: public void setSubscriberSubscriptionRestoredHandlerName(
419: String pSubscriberSubscriptionRestoredHandlerName) {
420: mSubscriberSubscriptionRestoredHandlerName = pSubscriberSubscriptionRestoredHandlerName;
421: }
422:
423: /** Getter for the name of the SubscriptionTerminated handler method inside the Subscriber */
424: public String getSubscriberSubscriptionTerminatedHandlerName() {
425: return mSubscriberSubscriptionTerminatedHandlerName;
426: }
427:
428: /** Setter for the name of the SubscriptionTerminated handler method inside the Subscriber */
429: public void setSubscriberSubscriptionTerminatedHandlerName(
430: String pSubscriberSubscriptionTerminatedHandlerName) {
431: mSubscriberSubscriptionTerminatedHandlerName = pSubscriberSubscriptionTerminatedHandlerName;
432: }
433:
434: /** Getter for the name of the class implementing event synchroniser for this event subscription */
435: public String getPublisherSynchroniserImplementationClassName() {
436: return mPublisherSynchroniserImplementationClassName;
437: }
438:
439: /** Setter for the name of the class implementing event synchroniser for this event subscription */
440: public void setPublisherSynchroniserImplementationClassName(
441: String pPublisherSynchroniserImplementationClassName) {
442: mPublisherSynchroniserImplementationClassName = pPublisherSynchroniserImplementationClassName;
443: }
444:
445: /** Getter for the name of the factory for the implementation of event synchroniser for this event subscription */
446: public String getPublisherSynchroniserImplementationFactoryClassName() {
447: return mPublisherSynchroniserImplementationFactoryClassName;
448: }
449:
450: /** Setter for the name of the factory for the implementation of event synchroniser for this event subscription */
451: public void setPublisherSynchroniserImplementationFactoryClassName(
452: String pPublisherSynchroniserImplementationFactoryClassName) {
453: mPublisherSynchroniserImplementationFactoryClassName = pPublisherSynchroniserImplementationFactoryClassName;
454: }
455:
456: /** Getter for the name of the class implementing event sink for this event subscription */
457: public String getPublisherEventSinkImplementationClassName() {
458: return mPublisherEventSinkImplementationClassName;
459: }
460:
461: /** Setter for the name of the class implementing event sink for this event subscription */
462: public void setPublisherEventSinkImplementationClassName(
463: String pPublisherEventSinkImplementationClassName) {
464: mPublisherEventSinkImplementationClassName = pPublisherEventSinkImplementationClassName;
465: }
466:
467: /** Getter for the name of the factory class implementing event sink for this event subscription */
468: public String getPublisherEventSinkImplementationFactoryClassName() {
469: return mPublisherEventSinkImplementationFactoryClassName;
470: }
471:
472: /** Setter for the name of the factory class implementing event sink for this event subscription */
473: public void setPublisherEventSinkImplementationFactoryClassName(
474: String pPublisherEventSinkImplementationFactoryClassName) {
475: mPublisherEventSinkImplementationFactoryClassName = pPublisherEventSinkImplementationFactoryClassName;
476: }
477: }
|