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: import java.util.Properties;
018:
019: /** This structure contains the stylesheet (set of names) pertained to the particular domain */
020: public final class STDatatypeStylesheet {
021: private String mDatatypeRef = null;
022: private String mNormalisedName = null;
023: private String mNormalisedTypedName = null;
024: private String mPackageName = null;
025: private String mClassName = null;
026: private String mClassFullName = null;
027: private String mDescriptionHtmlText = null;
028: private String mDescriptionPlainText = null;
029: private Properties mTypetemplateProperties = null;
030: private String mCataloguePathToTop = null;
031: private String mCataloguePathFromTop = null;
032: private String mNamespaceURI = null;
033:
034: /** Getter for the unique identifier of the corresponding domain */
035: public String getDatatypeRef() {
036: return mDatatypeRef;
037: }
038:
039: /** Getter for the normalised name of the element. Normalised name is a
040: * "safe to use in computing" kind of name it must be a single word consisting of
041: * the most basic set of characters (e.g. letters, numbers, underscores).
042: * Note that this name may not be unique in the namespace of the parent element, because
043: * sibling element of another type may have the same name. Consider using NormalisedTypedName to get more unique name */
044: public String getNormalisedName() {
045: return mNormalisedName;
046: }
047:
048: /** Getter for the normalised typed name of the element.
049: * Normalised typed name is similar to the normalised name, but it is derived
050: * from type name and element name which guarantees that this name is unique within parent element scope. */
051: public String getNormalisedTypedName() {
052: return mNormalisedTypedName;
053: }
054:
055: /** Setter for the normalised typed name of the element.
056: * Normalised typed name is similar to the normalised name, but it is derived
057: * from type name and element name which guarantees that this name is unique within parent element scope. */
058: public void setNormalisedTypedName(String pNormalisedTypedName) {
059: mNormalisedTypedName = pNormalisedTypedName;
060: }
061:
062: /** Getter for the relative path to the top from the catalogue where information related to this object is located.
063: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
064: * It is used for things like help files, documentation directory tree etc. */
065: public String getCataloguePathToTop() {
066: return mCataloguePathToTop;
067: }
068:
069: /** Getter for the relative path from the top to the catalogue where information related to this object is located.
070: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
071: * It is used for things like help files, documentation directory tree etc. */
072: public String getCataloguePathFromTop() {
073: return mCataloguePathFromTop;
074: }
075:
076: /** Setter for the relative path to the top from the catalogue where information related to this object is located.
077: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
078: * It is used for things like help files, documentation directory tree etc. */
079: public void setCataloguePathToTop(String pCataloguePathToTop) {
080: mCataloguePathToTop = pCataloguePathToTop;
081: }
082:
083: /** Setter for the relative path from the top to the catalogue where information related to this object is located
084: * Catalogue is a directory tree where each node is named as <owner type>_<owner normalised name>.
085: * It is used for things like help files, documentation directory tree etc. */
086: public void setCataloguePathFromTop(String pCataloguePathFromTop) {
087: mCataloguePathFromTop = pCataloguePathFromTop;
088: }
089:
090: /** Getter for the package name where datatype class is located */
091: public String getPackageName() {
092: return mPackageName;
093: }
094:
095: /** Getter for the datatype class name */
096: public String getClassName() {
097: return mClassName;
098: }
099:
100: /** Getter for the datatype full class name (includes package and class) */
101: public String getClassFullName() {
102: return mClassFullName;
103: }
104:
105: /** Getter for the html text of the description. */
106: public String getDescriptionHtmlText() {
107: return mDescriptionHtmlText;
108: }
109:
110: /** Getter for the plain text of the description */
111: public String getDescriptionPlainText() {
112: return mDescriptionPlainText;
113: }
114:
115: /** Getter for the property bag populated with template properties.
116: * @return null if this DataType is not generated via Typetemplate */
117: public Properties getTypetemplateProperties() {
118: return mTypetemplateProperties;
119: }
120:
121: /** Setter for the unique identifier of the corresponding domain */
122: public void setDatatypeRef(String pDatatypeRef) {
123: mDatatypeRef = pDatatypeRef;
124: }
125:
126: /** Setter for the normalised name of the element. Normalised name is a
127: * "safe to use in computing" kind of name it must be a single word consisting of
128: * the most basic set of characters (e.g. letters, numbers, underscores).
129: * Note that this name may not be unique in the namespace of the parent element, because
130: * sibling element of another type may have the same name. Consider using NormalisedTypedName to get more unique name */
131: public void setNormalisedName(String pNormalisedName) {
132: mNormalisedName = pNormalisedName;
133: }
134:
135: /** Setter for the package name where datatype class is located */
136: public void setPackageName(String pPackageName) {
137: mPackageName = pPackageName;
138: }
139:
140: /** Setter for the datatype class name */
141: public void setClassName(String pClassName) {
142: mClassName = pClassName;
143: }
144:
145: /** Setter for the datatype full class name (includes package and class) */
146: public void setClassFullName(String pClassFullName) {
147: mClassFullName = pClassFullName;
148: }
149:
150: /** Setter for the text of the description. */
151: public void setDescriptionHtmlText(String pDescriptionHtmlText) {
152: mDescriptionHtmlText = pDescriptionHtmlText;
153: }
154:
155: /** Setter for the plain text of the description */
156: public void setDescriptionPlainText(String pDescriptionPlainText) {
157: mDescriptionPlainText = pDescriptionPlainText;
158: }
159:
160: /** Setter for the property bag populated with template properties. */
161: public void setTypetemplateProperties(
162: Properties pTypetemplateProperties) {
163: mTypetemplateProperties = pTypetemplateProperties;
164: }
165:
166: /** Getter for the standard xml schema namespace */
167: public String getNamespaceURI() {
168: return mNamespaceURI;
169: }
170:
171: /** Setter for the generic xml name space URI */
172: public void setNamespaceURI(String pNamespaceURI) {
173: mNamespaceURI = pNamespaceURI;
174: }
175:
176: }
|