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 entity */
018: public final class STEntityStylesheet {
019: private String mEntityRef = null;
020: private String mNormalisedName = null;
021: private String mNormalisedPluralName = null;
022: private String mNormalisedTypedName = null;
023: private String mServiceDetailsStructureName = null;
024: private String mServiceKeyStructureName = null;
025: private String mServiceInstanceNotFoundMessageName = null;
026: private String mServiceDuplicateCreateFailedMessageName = null;
027: private String mServiceVersionMismatchMessageName = null;
028: private String mServiceDetailsStructureTranslatorName = null;
029: private String mInstanceIdServiceStructureAttributeName = null;
030: private String mVersionIdServiceStructureAttributeName = null;
031: private String mStateServiceStructureAttributeName = null;
032: private String mDomainInterfaceName = null;
033: private String mDomainPackageName = null;
034: private String mDomainInterfaceFullName = null;
035: private String mDomainImplementationName = null;
036: private String mDomainCollectionInterfaceName = null;
037: private String mDomainCollectionInterfaceFullName = null;
038: private String mDomainCollectionImplementationName = null;
039: private String mInstanceIdDomainObjectAttributeName = null;
040: private String mVersionIdDomainObjectAttributeName = null;
041: private String mStateDomainObjectAttributeName = null;
042: private String mInstanceIdStorageStructureAttributeName = null;
043: private String mVersionIdStorageStructureAttributeName = null;
044: private String mStateStorageStructureAttributeName = null;
045: private String mSupertypeStorageStructureAttributeName = null;
046: private String mStorageInterfaceName = null;
047: private String mStorageRecordName = null;
048: private String mStoragePackageName = null;
049: private String mStorageInterfaceFullName = null;
050: private String mStorageRecordFullName = null;
051: private String mStorageImplementationName = null;
052: private String mStorageFactoryName = null;
053: private String mCataloguePathToTop = null;
054: private String mCataloguePathFromTop = null;
055:
056: /** Getter for the unique identifier of the corresponding entity */
057: public String getEntityRef() {
058: return mEntityRef;
059: }
060:
061: /** Getter for the normalised name of the element. Normalised name is a
062: * "safe to use in computing" kind of name it must be a single word consisting of
063: * the most basic set of characters (e.g. letters, numbers, underscores).
064: * Note that this name may not be unique in the namespace of the parent element, because
065: * sibling element of another type may have the same name. Consider using NormalisedTypedName to get more unique name */
066: public String getNormalisedName() {
067: return mNormalisedName;
068: }
069:
070: /** Getter for the normalised plural name of the element. Normalised name is a
071: * "safe to use in computing" kind of name it must be a single word consisting of
072: * the most basic set of characters (e.g. letters, numbers, underscores).
073: * Note that this name may not be unique in the namespace of the parent element, because
074: * sibling element of another type may have the same name. Consider using NormalisedTypedName to get more unique name */
075: public String getNormalisedPluralName() {
076: return mNormalisedPluralName;
077: }
078:
079: /** Getter for the normalised typed name of the element.
080: * Normalised typed name is similar to the normalised name, but it is derived
081: * from type name and element name which guarantees that this name is unique within parent element scope. */
082: public String getNormalisedTypedName() {
083: return mNormalisedTypedName;
084: }
085:
086: /** Setter for the normalised typed name of the element.
087: * Normalised typed name is similar to the normalised name, but it is derived
088: * from type name and element name which guarantees that this name is unique within parent element scope. */
089: public void setNormalisedTypedName(String pNormalisedTypedName) {
090: mNormalisedTypedName = pNormalisedTypedName;
091: }
092:
093: /** Getter for the name of the structure representing this entity in the services layer
094: * for example inside domain administration service each entity is represented by a structure
095: * This structure resides in structure's domain support servicemodule, so this value is in fact derived */
096: public String getServiceDetailsStructureName() {
097: return mServiceDetailsStructureName;
098: }
099:
100: /** Getter for the name of the structure representing key to this entity in the services layer
101: * for example inside domain administration service each entity is accessible via its key structure
102: * This structure resides in structure's domain support servicemodule, so this value is in fact derived */
103: public String getServiceKeyStructureName() {
104: return mServiceKeyStructureName;
105: }
106:
107: /** Getter for the name of the message sent from the update method when superceeded version has been
108: * discovered and update has failed. This message resides in domain support servicemodule, so this value is in fact derived */
109: public String getServiceVersionMismatchMessageName() {
110: return mServiceVersionMismatchMessageName;
111: }
112:
113: /** Getter for the name of the message sent from the method when requiested instance was not found
114: * This message resides in domain support servicemodule, so this value is in fact derived */
115: public String getServiceInstanceNotFoundMessageName() {
116: return mServiceInstanceNotFoundMessageName;
117: }
118:
119: /** Getter for the reference of the message sent from the create method when duplicate primary key has been
120: * specified and creation has failed. This message resides in domain support servicemodule, so this value is in fact derived */
121: public String getServiceDuplicateCreateFailedMessageName() {
122: return mServiceDuplicateCreateFailedMessageName;
123: }
124:
125: /** Getter for the name of the class translating entity contents to/from structure */
126: public String getServiceDetailsStructureTranslatorName() {
127: return mServiceDetailsStructureTranslatorName;
128: }
129:
130: /** Getter for the name of the interface representing this entity */
131: public String getDomainInterfaceName() {
132: return mDomainInterfaceName;
133: }
134:
135: /** Getter for the name of the implementation class implementing domain interface */
136: public String getDomainImplementationName() {
137: return mDomainImplementationName;
138: }
139:
140: /** Getter for the name of the package where domain interface representing this entity is located */
141: public String getDomainPackageName() {
142: return mDomainPackageName;
143: }
144:
145: /** Getter for the full name of the interface representing this entity */
146: public String getDomainInterfaceFullName() {
147: return mDomainInterfaceFullName;
148: }
149:
150: /** Getter for the name of the interface for the domain object collection */
151: public String getDomainCollectionInterfaceName() {
152: return mDomainCollectionInterfaceName;
153: }
154:
155: /** Getter for the full name of the interface for the domain object collection */
156: public String getDomainCollectionInterfaceFullName() {
157: return mDomainCollectionInterfaceFullName;
158: }
159:
160: /** Getter for the name of the implementation for the domain object collection */
161: public String getDomainCollectionImplementationName() {
162: return mDomainCollectionImplementationName;
163: }
164:
165: /** Getter for the name of the instance id attribute in the storage structure */
166: public String getInstanceIdStorageStructureAttributeName() {
167: return mInstanceIdStorageStructureAttributeName;
168: }
169:
170: /** Getter for the name of the instance id attribute in the service structure */
171: public String getInstanceIdServiceStructureAttributeName() {
172: return mInstanceIdServiceStructureAttributeName;
173: }
174:
175: /** Getter for the name of the instance id attribute in the domain object */
176: public String getInstanceIdDomainObjectAttributeName() {
177: return mInstanceIdDomainObjectAttributeName;
178: }
179:
180: /** Getter for the name of the version id attribute in the storage structure */
181: public String getVersionIdStorageStructureAttributeName() {
182: return mVersionIdStorageStructureAttributeName;
183: }
184:
185: /** Getter for the name of the version id attribute in the service structure */
186: public String getVersionIdServiceStructureAttributeName() {
187: return mVersionIdServiceStructureAttributeName;
188: }
189:
190: /** Getter for the name of the version id attribute in the domain object */
191: public String getVersionIdDomainObjectAttributeName() {
192: return mVersionIdDomainObjectAttributeName;
193: }
194:
195: /** Getter for the name of the state attribute in the storage structure */
196: public String getStateStorageStructureAttributeName() {
197: return mStateStorageStructureAttributeName;
198: }
199:
200: /** Getter for the name of the supertype structure reference in the storage structure */
201: public String getSupertypeStorageStructureAttributeName() {
202: return mSupertypeStorageStructureAttributeName;
203: }
204:
205: /** Getter for the name of the state attribute in the service structure */
206: public String getStateServiceStructureAttributeName() {
207: return mStateServiceStructureAttributeName;
208: }
209:
210: /** Getter for the name of the state attribute in the domain object */
211: public String getStateDomainObjectAttributeName() {
212: return mStateDomainObjectAttributeName;
213: }
214:
215: /** Getter for the name of the storage service interface for this entity */
216: public String getStorageInterfaceName() {
217: return mStorageInterfaceName;
218: }
219:
220: /** Getter for the name of the storage record for this entity */
221: public String getStorageRecordName() {
222: return mStorageRecordName;
223: }
224:
225: /** Getter for the name of the implementation class implementing storage service for this entity */
226: public String getStorageImplementationName() {
227: return mStorageImplementationName;
228: }
229:
230: /** Getter for the name of the package where storage service for this entity is located */
231: public String getStoragePackageName() {
232: return mStoragePackageName;
233: }
234:
235: /** Getter for the full name of the storage service interface for this entity */
236: public String getStorageInterfaceFullName() {
237: return mStorageInterfaceFullName;
238: }
239:
240: /** Getter for the full name of the storage record for this entity */
241: public String getStorageRecordFullName() {
242: return mStorageRecordFullName;
243: }
244:
245: /** Getter for the name of the factory of the implementation class implementing storage service for this entity */
246: public String getStorageFactoryName() {
247: return mStorageFactoryName;
248: }
249:
250: /** Getter for the relative path to the top from the catalogue where information related to this object is located.
251: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
252: * It is used for things like help files, documentation directory tree etc. */
253: public String getCataloguePathToTop() {
254: return mCataloguePathToTop;
255: }
256:
257: /** Getter for the relative path from the top to the catalogue where information related to this object is located.
258: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
259: * It is used for things like help files, documentation directory tree etc. */
260: public String getCataloguePathFromTop() {
261: return mCataloguePathFromTop;
262: }
263:
264: /** Setter for the unique identifier of the corresponding entity */
265: public void setEntityRef(String pEntityRef) {
266: mEntityRef = pEntityRef;
267: }
268:
269: /** Setter for the normalised name of the element. Normalised name is a
270: * "safe to use in computing" kind of name it must be a single word consisting of
271: * the most basic set of characters (e.g. letters, numbers, underscores).
272: * Note that this name may not be unique in the namespace of the parent element, because
273: * sibling element of another type may have the same name. Consider using NormalisedTypedName to get more unique name */
274: public void setNormalisedName(String pNormalisedName) {
275: mNormalisedName = pNormalisedName;
276: }
277:
278: /** Setter for the normalised plural name of the element. Normalised name is a
279: * "safe to use in computing" kind of name it must be a single word consisting of
280: * the most basic set of characters (e.g. letters, numbers, underscores).
281: * Note that this name may not be unique in the namespace of the parent element, because
282: * sibling element of another type may have the same name. Consider using NormalisedTypedName to get more unique name */
283: public void setNormalisedPluralName(String pNormalisedPluralName) {
284: mNormalisedPluralName = pNormalisedPluralName;
285: }
286:
287: /** Setter for the name of the structure representing this entity in the services layer
288: * for example inside domain administration service each entity is represented by a structure
289: * This structure resides in structure's domain support servicemodule, so this value is in fact derived */
290: public void setServiceDetailsStructureName(
291: String pServiceDetailsStructureName) {
292: mServiceDetailsStructureName = pServiceDetailsStructureName;
293: }
294:
295: /** Setter for the name of the structure representing key to this entity in the services layer
296: * for example inside domain administration service each entity is accessible via its key structure
297: * This structure resides in structure's domain support servicemodule, so this value is in fact derived */
298: public void setServiceKeyStructureName(
299: String pServiceKeyStructureName) {
300: mServiceKeyStructureName = pServiceKeyStructureName;
301: }
302:
303: /** Setter for the name of the message sent from thesent from the method when requiested instance was not found
304: * This message resides in domain support servicemodule, so this value is in fact derived */
305: public void setServiceInstanceNotFoundMessageName(
306: String pServiceInstanceNotFoundMessageName) {
307: mServiceInstanceNotFoundMessageName = pServiceInstanceNotFoundMessageName;
308: }
309:
310: /** Setter for the name of the message sent from the create method when duplicate primary key has been
311: * specified and creation has failed. This message resides in domain support servicemodule, so this value is in fact derived */
312: public void setServiceDuplicateCreateFailedMessageName(
313: String pServiceDuplicateCreateFailedMessageName) {
314: mServiceDuplicateCreateFailedMessageName = pServiceDuplicateCreateFailedMessageName;
315: }
316:
317: /** Setter for the name of the message sent from the update method when mismatched version id has been
318: * discovered and update has failed. This message resides in domain support servicemodule, so this value is in fact derived */
319: public void setServiceVersionMismatchMessageName(
320: String pServiceVersionMismatchMessageName) {
321: mServiceVersionMismatchMessageName = pServiceVersionMismatchMessageName;
322: }
323:
324: /** Setter for the name of the class translating entity contents to/from structure */
325: public void setServiceDetailsStructureTranslatorName(
326: String pServiceDetailsStructureTranslatorName) {
327: mServiceDetailsStructureTranslatorName = pServiceDetailsStructureTranslatorName;
328: }
329:
330: /** Setter for the name of the interface representing this entity */
331: public void setDomainInterfaceName(String pDomainInterfaceName) {
332: mDomainInterfaceName = pDomainInterfaceName;
333: }
334:
335: /** Setter for the name of the implementation class implementing domain interface */
336: public void setDomainImplementationName(
337: String pDomainImplementationName) {
338: mDomainImplementationName = pDomainImplementationName;
339: }
340:
341: /** Setter for the name of the package where domain interface representing this entity is located */
342: public void setDomainPackageName(String pDomainPackageName) {
343: mDomainPackageName = pDomainPackageName;
344: }
345:
346: /** SGetter for the full name of the interface representing this entity */
347: public void setDomainInterfaceFullName(
348: String pDomainInterfaceFullName) {
349: mDomainInterfaceFullName = pDomainInterfaceFullName;
350: }
351:
352: /** Setter for the name of the interface for the domain object collection */
353: public void setDomainCollectionInterfaceName(
354: String pDomainCollectionInterfaceName) {
355: mDomainCollectionInterfaceName = pDomainCollectionInterfaceName;
356: }
357:
358: /** Setter for the full name of the interface for the domain object collection */
359: public void setDomainCollectionInterfaceFullName(
360: String pDomainCollectionInterfaceFullName) {
361: mDomainCollectionInterfaceFullName = pDomainCollectionInterfaceFullName;
362: }
363:
364: /** Setter for the name of the implementation for the domain object collection */
365: public void setDomainCollectionImplementationName(
366: String pDomainCollectionImplementationName) {
367: mDomainCollectionImplementationName = pDomainCollectionImplementationName;
368: }
369:
370: /** Setter for the name of the instance id attribute in the storage structure */
371: public void setInstanceIdStorageStructureAttributeName(
372: String pInstanceIdStorageStructureAttributeName) {
373: mInstanceIdStorageStructureAttributeName = pInstanceIdStorageStructureAttributeName;
374: }
375:
376: /** Setter for the name of the instance id attribute in the service structure */
377: public void setInstanceIdServiceStructureAttributeName(
378: String pInstanceIdServiceStructureAttributeName) {
379: mInstanceIdServiceStructureAttributeName = pInstanceIdServiceStructureAttributeName;
380: }
381:
382: /** Setter for the name of the instance id attribute in the domain object */
383: public void setInstanceIdDomainObjectAttributeName(
384: String pInstanceIdDomainObjectAttributeName) {
385: mInstanceIdDomainObjectAttributeName = pInstanceIdDomainObjectAttributeName;
386: }
387:
388: /** Setter for the name of the version id attribute in the storage structure */
389: public void setVersionIdStorageStructureAttributeName(
390: String pVersionIdStorageStructureAttributeName) {
391: mVersionIdStorageStructureAttributeName = pVersionIdStorageStructureAttributeName;
392: }
393:
394: /** Setter for the name of the version id attribute in the service structure */
395: public void setVersionIdServiceStructureAttributeName(
396: String pVersionIdServiceStructureAttributeName) {
397: mVersionIdServiceStructureAttributeName = pVersionIdServiceStructureAttributeName;
398: }
399:
400: /** Setter for the name of the version id attribute in the domain object */
401: public void setVersionIdDomainObjectAttributeName(
402: String pVersionIdDomainObjectAttributeName) {
403: mVersionIdDomainObjectAttributeName = pVersionIdDomainObjectAttributeName;
404: }
405:
406: /** Setter for the name of the state attribute in the storage structure */
407: public void setStateStorageStructureAttributeName(
408: String pStateStorageStructureAttributeName) {
409: mStateStorageStructureAttributeName = pStateStorageStructureAttributeName;
410: }
411:
412: /** Setter for the name of the state attribute in the service structure */
413: public void setStateServiceStructureAttributeName(
414: String pStateServiceStructureAttributeName) {
415: mStateServiceStructureAttributeName = pStateServiceStructureAttributeName;
416: }
417:
418: /** Setter for the name of the supertype reference in the storage structure */
419: public void setSupertypeStorageStructureAttributeName(
420: String pSupertypeStorageStructureAttributeName) {
421: mSupertypeStorageStructureAttributeName = pSupertypeStorageStructureAttributeName;
422: }
423:
424: /** Setter for the name of the state attribute in the domain object */
425: public void setStateDomainObjectAttributeName(
426: String pStateDomainObjectAttributeName) {
427: mStateDomainObjectAttributeName = pStateDomainObjectAttributeName;
428: }
429:
430: /** Setter for the name of the storage service interface for this entity */
431: public void setStorageInterfaceName(String pStorageInterfaceName) {
432: mStorageInterfaceName = pStorageInterfaceName;
433: }
434:
435: /** Setter for the name of the storage record for this entity */
436: public void setStorageRecordName(String pStorageRecordName) {
437: mStorageRecordName = pStorageRecordName;
438: }
439:
440: /** Setter for the name of the implementation class of the storage service for this entity */
441: public void setStorageImplementationName(
442: String pStorageImplementationName) {
443: mStorageImplementationName = pStorageImplementationName;
444: }
445:
446: /** Setter for the name of the package where storage service interface for this entity is located */
447: public void setStoragePackageName(String pStoragePackageName) {
448: mStoragePackageName = pStoragePackageName;
449: }
450:
451: /** Setter for the full name of the storage servide interface for this entity */
452: public void setStorageInterfaceFullName(
453: String pStorageInterfaceFullName) {
454: mStorageInterfaceFullName = pStorageInterfaceFullName;
455: }
456:
457: /** Setter for the full name of the storage record for this entity */
458: public void setStorageRecordFullName(String pStorageRecordFullName) {
459: mStorageRecordFullName = pStorageRecordFullName;
460: }
461:
462: /** Setter for the name of the factory of the implementation class of the storage service for this entity */
463: public void setStorageFactoryName(String pStorageFactoryName) {
464: mStorageFactoryName = pStorageFactoryName;
465: }
466:
467: /** Setter for the relative path to the top from the catalogue where information related to this object is located.
468: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
469: * It is used for things like help files, documentation directory tree etc. */
470: public void setCataloguePathToTop(String pCataloguePathToTop) {
471: mCataloguePathToTop = pCataloguePathToTop;
472: }
473:
474: /** Setter for the relative path from the top to the catalogue where information related to this object is located
475: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
476: * It is used for things like help files, documentation directory tree etc. */
477: public void setCataloguePathFromTop(String pCataloguePathFromTop) {
478: mCataloguePathFromTop = pCataloguePathFromTop;
479: }
480:
481: }
|