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 structure */
018: public final class STStructureStylesheet {
019: private String mStructureRef = 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 mValidatorClassName = null;
028: private String mCataloguePathToTop = null;
029: private String mCataloguePathFromTop = null;
030: private String mNamespaceURI;
031:
032: /** Getter for the unique identifier of the corresponding structure */
033: public String getStructureRef() {
034: return mStructureRef;
035: }
036:
037: /** Getter for the normalised name of the element. Normalised name is a
038: * "safe to use in computing" kind of name it must be a single word consisting of
039: * the most basic set of characters (e.g. letters, numbers, underscores).
040: * Note that this name may not be unique in the namespace of the parent element, because
041: * sibling element of another type may have the same name. Consider using NormalisedTypedName to get more unique name */
042: public String getNormalisedName() {
043: return mNormalisedName;
044: }
045:
046: /** Getter for the normalised typed name of the element.
047: * Normalised typed name is similar to the normalised name, but it is derived
048: * from type name and element name which guarantees that this name is unique within parent element scope. */
049: public String getNormalisedTypedName() {
050: return mNormalisedTypedName;
051: }
052:
053: /** Setter for the normalised typed name of the element.
054: * Normalised typed name is similar to the normalised name, but it is derived
055: * from type name and element name which guarantees that this name is unique within parent element scope. */
056: public void setNormalisedTypedName(String pNormalisedTypedName) {
057: mNormalisedTypedName = pNormalisedTypedName;
058: }
059:
060: /** Getter for the name of the class realising this structure */
061: public String getClassName() {
062: return mClassName;
063: }
064:
065: /** Getter for the package name of the class realising this structure */
066: public String getPackageName() {
067: return mPackageName;
068: }
069:
070: /** Getter for the full (package and name) name of the class realising this structure */
071: public String getClassFullName() {
072: return mClassFullName;
073: }
074:
075: /** Getter for the name of the proxy class to this structure. Use it to name the CORBA, RMI etc
076: * proxy structures (structures which carry the same data but may use different
077: * datatypes depending on the nature of the technolgy. Note that this proxy class
078: * may reside in any package as chosen by generator (in fact there will
079: * most probably be more than one implementation each in different package) */
080: public String getProxyClassName() {
081: return mProxyClassName;
082: }
083:
084: /** Getter for the name of the proxy translator class to this structure. Use it to name the CORBA, RMI etc
085: * proxy translation helpers (classes which help copying the data between
086: * actual structures and their proxies. Note that this proxy translator class
087: * may reside in any package as chosen by generator (in fact there will
088: * most probably be more than one implementation each in different package) */
089: public String getProxyTranslatorClassName() {
090: return mProxyTranslatorClassName;
091: }
092:
093: /** Getter for the relative path to the top from the catalogue where information related to this object is located.
094: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
095: * It is used for things like help files, documentation directory tree etc. */
096: public String getCataloguePathToTop() {
097: return mCataloguePathToTop;
098: }
099:
100: /** Getter for the relative path from the top to the catalogue where information related to this object is located.
101: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
102: * It is used for things like help files, documentation directory tree etc. */
103: public String getCataloguePathFromTop() {
104: return mCataloguePathFromTop;
105: }
106:
107: /** Setter for the unique identifier of the corresponding structure */
108: public void setStructureRef(String pStructureRef) {
109: mStructureRef = pStructureRef;
110: }
111:
112: /** Setter for the normalised name of the element. Normalised name is a
113: * "safe to use in computing" kind of name it must be a single word consisting of
114: * the most basic set of characters (e.g. letters, numbers, underscores)
115: * Note that this name may not be unique in the namespace of the parent element, because
116: * sibling element of another type may have the same name. Consider using NormalisedTypedName to get more unique name */
117: public void setNormalisedName(String pNormalisedName) {
118: mNormalisedName = pNormalisedName;
119: }
120:
121: /** Setter for the name of the class realising this structure */
122: public void setClassName(String pClassName) {
123: mClassName = pClassName;
124: }
125:
126: /** Setter for the package name of the class realising this structure */
127: public void setPackageName(String pPackageName) {
128: mPackageName = pPackageName;
129: }
130:
131: /** Setter for the full (package and name) name of the class realising this structure */
132: public void setClassFullName(String pClassFullName) {
133: mClassFullName = pClassFullName;
134: }
135:
136: /** Setter for the name of the proxy class to this structure. Use it to name the CORBA, RMI etc
137: * proxy structures (structures which carry the same data but may use different
138: * datatypes depending on the nature of the technolgy. Note that this proxy class
139: * may reside in any package as chosen by generator (in fact there will
140: * most probably be more than one implementation each in different package) */
141: public void setProxyClassName(String pProxyClassName) {
142: mProxyClassName = pProxyClassName;
143: }
144:
145: /** Setter for the name of the proxy translator class to this structure. Use it to name the CORBA, RMI etc
146: * proxy translation helpers (classes which help copying the data between
147: * actual structures and their proxies. Note that this proxy translator class
148: * may reside in any package as chosen by generator (in fact there will
149: * most probably be more than one implementation each in different package) */
150: public void setProxyTranslatorClassName(
151: String pProxyTranslatorClassName) {
152: mProxyTranslatorClassName = pProxyTranslatorClassName;
153: }
154:
155: /** Setter for the relative path to the top from the catalogue where information related to this object is located.
156: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
157: * It is used for things like help files, documentation directory tree etc. */
158: public void setCataloguePathToTop(String pCataloguePathToTop) {
159: mCataloguePathToTop = pCataloguePathToTop;
160: }
161:
162: /** Setter for the relative path from the top to the catalogue where information related to this object is located
163: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
164: * It is used for things like help files, documentation directory tree etc. */
165: public void setCataloguePathFromTop(String pCataloguePathFromTop) {
166: mCataloguePathFromTop = pCataloguePathFromTop;
167: }
168:
169: /** Getter for the standard xml schema namespace */
170: public String getNamespaceURI() {
171: return mNamespaceURI;
172: }
173:
174: /** Setter for the generic xml name space URI */
175: public void setNamespaceURI(String pNamespaceURI) {
176: mNamespaceURI = pNamespaceURI;
177: }
178:
179: /** Getter for the name of the validator class to this structure. Use it to name the
180: * utility classes which perform validation of the data in the structure. */
181: public String getValidatorClassName() {
182: return mValidatorClassName;
183: }
184:
185: /** Setter for the name of the validator class to this structure. Use it to name the
186: * utility classes which perform validation of the data in the structure. */
187: public void setValidatorClassName(String pValidatorClassName) {
188: mValidatorClassName = pValidatorClassName;
189: }
190: }
|