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 with values controlling documentation styles */
018: public final class STDocumentationStylesheet {
019: private String mDescriptionOpeningTags = null;
020: private String mDescriptionClosingTags = null;
021: private String mMissingDescriptionHtmlText = null;
022: private String mMissingDescriptionPlainText = null;
023: private String mCopyrightCommentInC = null;
024: private String mCopyrightCommentInJava = null;
025: private String mCopyrightCommentInProperties = null;
026: private String mCopyrightCommentInXml = null;
027: private String mCopyrightCommentInHtml = null;
028: private String mCopyrightCommentInSql = null;
029: private String mModelName = null;
030:
031: /** Getter for the C text of the copyright comment i.e. "/* Copyright 2000-2005 © Acme Pty.Ltd. All Rights Reserved " */
032: public String getCopyrightCommentInC() {
033: return mCopyrightCommentInC;
034: }
035:
036: /** Getter for the Java text of the copyright comment i.e. "// Copyright 2000-2005 © Acme Pty.Ltd. All Rights Reserved " */
037: public String getCopyrightCommentInJava() {
038: return mCopyrightCommentInJava;
039: }
040:
041: /** Getter for the Properties text of the copyright comment i.e. "# Copyright 2000-2005 © Acme Pty.Ltd. All Rights Reserved "*/
042: public String getCopyrightCommentInProperties() {
043: return mCopyrightCommentInProperties;
044: }
045:
046: /** Getter for the Xml text of the copyright comment. For example : "<!-- Copyright 2000-2004 © Acme Pty.Ltd. All Rights Reserved -->" */
047: public String getCopyrightCommentInXml() {
048: return mCopyrightCommentInXml;
049: }
050:
051: /** Getter for the Html text of the copyright comment. For example : "<!-- Copyright 2000-2004 © Acme Pty.Ltd. All Rights Reserved -->" */
052: public String getCopyrightCommentInHtml() {
053: return mCopyrightCommentInHtml;
054: }
055:
056: /** Getter for the Sql text of the copyright comment. For example : "-- Copyright 2000-2004 © Acme Pty.Ltd. All Rights Reserved" */
057: public String getCopyrightCommentInSql() {
058: return mCopyrightCommentInSql;
059: }
060:
061: /** Getter for the html text of the missing description i.e. "<font color="red">Missing from the model</font>" */
062: public String getMissingDescriptionHtmlText() {
063: return mMissingDescriptionHtmlText;
064: }
065:
066: /** Getter for the plain text of the missing description i.e. "Missing from the model" */
067: public String getMissingDescriptionPlainText() {
068: return mMissingDescriptionPlainText;
069: }
070:
071: /** Getter for the tags preceeding description i.e. "<i>" */
072: public String getDescriptionOpeningTags() {
073: return mDescriptionOpeningTags;
074: }
075:
076: /** Getter for the tags following description i.e. "</i>" */
077: public String getDescriptionClosingTags() {
078: return mDescriptionClosingTags;
079: }
080:
081: /** Setter for the C text of the copyright comment i.e. "/* Copyright 2000-2004 © Acme Pty.Ltd. All Rights Reserved " */
082: public void setCopyrightCommentInC(String pCopyrightCommentInC) {
083: mCopyrightCommentInC = pCopyrightCommentInC;
084: }
085:
086: /** Setter for the Java text of the copyright comment i.e. "// Copyright 2000-2004 © Acme Pty.Ltd. All Rights Reserved " */
087: public void setCopyrightCommentInJava(String pCopyrightCommentInJava) {
088: mCopyrightCommentInJava = pCopyrightCommentInJava;
089: }
090:
091: /** Setter for the Properties text of the copyright comment i.e. "# Copyright 2000-2004 © Acme Pty.Ltd. All Rights Reserved "*/
092: public void setCopyrightCommentInProperties(
093: String pCopyrightCommentInProperties) {
094: mCopyrightCommentInProperties = pCopyrightCommentInProperties;
095: }
096:
097: /** Setter for the Xml text of the copyright comment. For example: "<!-- Copyright 2000-2004 © Acme Pty.Ltd. All Rights Reserved -->" */
098: public void setCopyrightCommentInXml(String pCopyrightCommentInXml) {
099: mCopyrightCommentInXml = pCopyrightCommentInXml;
100: }
101:
102: /** Setter for the Html text of the copyright comment. For example: "<!-- Copyright 2000-2004 © Acme Pty.Ltd. All Rights Reserved -->" */
103: public void setCopyrightCommentInHtml(String pCopyrightCommentInHtml) {
104: mCopyrightCommentInHtml = pCopyrightCommentInHtml;
105: }
106:
107: /** Setter for the Sql text of the copyright comment. For example: "-- Copyright 2000-2004 © Acme Pty.Ltd. All Rights Reserved" */
108: public void setCopyrightCommentInSql(String pCopyrightCommentInSql) {
109: mCopyrightCommentInSql = pCopyrightCommentInSql;
110: }
111:
112: /** Setter for the text of the missing description i.e. "<font color="red">Missing from the model</font>" */
113: public void setMissingDescriptionHtmlText(
114: String pMissingDescriptionHtmlText) {
115: mMissingDescriptionHtmlText = pMissingDescriptionHtmlText;
116: }
117:
118: /** Setter for the plain text of the missing description i.e. "Missing from the model" */
119: public void setMissingDescriptionPlainText(
120: String pMissingDescriptionPlainText) {
121: mMissingDescriptionPlainText = pMissingDescriptionPlainText;
122: }
123:
124: /** Setter for the tags preceeding description i.e. "<i>" */
125: public void setDescriptionOpeningTags(String pDescriptionOpeningTags) {
126: mDescriptionOpeningTags = pDescriptionOpeningTags;
127: }
128:
129: /** Setter for the tags following description i.e. "</i>" */
130: public void setDescriptionClosingTags(String pDescriptionClosingTags) {
131: mDescriptionClosingTags = pDescriptionClosingTags;
132: }
133:
134: /** Getter for the model name as it should be known in documentation.
135: * It is built from the RootModel eleement name and type as well as optional ModelVersion element */
136: public String getModelName() {
137: return mModelName;
138: }
139:
140: /** Setter for the model name as it should be known in documentation.
141: * It is built from the RootModel eleement name and type as well as optional ModelVersion element */
142: public void setModelName(String pModelName) {
143: mModelName = pModelName;
144: }
145: }
|