001: /*
002: The contents of this file are subject to the Common Public Attribution License
003: Version 1.0 (the "License"); you may not use this file except in compliance with
004: the License. You may obtain a copy of the License at
005: http://www.projity.com/license . The License is based on the Mozilla Public
006: License Version 1.1 but Sections 14 and 15 have been added to cover use of
007: software over a computer network and provide for limited attribution for the
008: Original Developer. In addition, Exhibit A has been modified to be consistent
009: with Exhibit B.
010:
011: Software distributed under the License is distributed on an "AS IS" basis,
012: WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
013: specific language governing rights and limitations under the License. The
014: Original Code is OpenProj. The Original Developer is the Initial Developer and
015: is Projity, Inc. All portions of the code written by Projity are Copyright (c)
016: 2006, 2007. All Rights Reserved. Contributors Projity, Inc.
017:
018: Alternatively, the contents of this file may be used under the terms of the
019: Projity End-User License Agreeement (the Projity License), in which case the
020: provisions of the Projity License are applicable instead of those above. If you
021: wish to allow use of your version of this file only under the terms of the
022: Projity License and not to allow others to use your version of this file under
023: the CPAL, indicate your decision by deleting the provisions above and replace
024: them with the notice and other provisions required by the Projity License. If
025: you do not delete the provisions above, a recipient may use your version of this
026: file under either the CPAL or the Projity License.
027:
028: [NOTE: The text of this license may differ slightly from the text of the notices
029: in Exhibits A and B of the license at http://www.projity.com/license. You should
030: use the latest text at http://www.projity.com/license for your modifications.
031: You may not remove this license text from the source files.]
032:
033: Attribution Information: Attribution Copyright Notice: Copyright © 2006, 2007
034: Projity, Inc. Attribution Phrase (not exceeding 10 words): Powered by OpenProj,
035: an open source solution from Projity. Attribution URL: http://www.projity.com
036: Graphic Image as provided in the Covered Code as file: openproj_logo.png with
037: alternatives listed on http://www.projity.com/logo
038:
039: Display of Attribution Information is required in Larger Works which are defined
040: in the CPAL as a work which combines Covered Code or portions thereof with code
041: not governed by the terms of the CPAL. However, in addition to the other notice
042: obligations, all copies of the Covered Code in Executable and Source Code form
043: distributed must, as a form of attribution of the original author, include on
044: each user interface screen the "OpenProj" logo visible to all users. The
045: OpenProj logo should be located horizontally aligned with the menu bar and left
046: justified on the top left of the screen adjacent to the File menu. The logo
047: must be at least 100 x 25 pixels. When users click on the "OpenProj" logo it
048: must direct them back to http://www.projity.com.
049: */
050: package com.projity.configuration;
051:
052: import java.util.ArrayList;
053: import java.util.Hashtable;
054:
055: import org.apache.commons.digester.Digester;
056:
057: import com.projity.graphic.configuration.SpreadSheetFieldArray;
058: import com.projity.strings.Messages;
059:
060: /**
061: * Holds the definition of a report read in from the view config
062: */
063: public class ReportDefinition implements NamedItem {
064:
065: private String name = null;
066: private String id = null;
067: private String file = null;
068: private boolean timeBased = false;
069:
070: private int collectionType = 0;
071:
072: /**
073: * @return Returns the collectionType.
074: */
075: public int getCollectionType() {
076: return collectionType;
077: }
078:
079: /**
080: * @param collectionType The collectionType to set.
081: */
082: public void setCollectionType(int collectionType) {
083: this .collectionType = collectionType;
084: }
085:
086: private Object reportObject = null;
087: private Hashtable reportColumnDefinitions = new Hashtable();
088:
089: /**
090: * @return Returns the columnsList.
091: */
092: public ArrayList getColumnsList() {
093: return columnsList;
094: }
095:
096: private ArrayList columnsList = new ArrayList();
097:
098: /**
099: * @return Returns the timeBased.
100: */
101: public boolean isTimeBased() {
102: return timeBased;
103: }
104:
105: /**
106: * @param timeBased The timeBased to set.
107: */
108: public void setTimeBased(boolean timeBased) {
109: this .timeBased = timeBased;
110: }
111:
112: public static final String CATEGORY = "Report";
113:
114: /* (non-Javadoc)
115: * @see com.projity.configuration.NamedItem#getName()
116: */
117: public String getName() {
118: return name;
119: }
120:
121: /* (non-Javadoc)
122: * @see com.projity.configuration.NamedItem#getCategory()
123: */
124: public String getCategory() {
125: return CATEGORY;
126: }
127:
128: public final void setName(String name) {
129: this .name = name;
130: }
131:
132: public final String getId() {
133: return id;
134: }
135:
136: public final void setId(String id) {
137: this .id = id;
138: if (name == null)
139: name = Messages.getString(id);
140: }
141:
142: public static void addDigesterEvents(Digester digester) {
143: digester.addObjectCreate("*/reports/report",
144: "com.projity.configuration.ReportDefinition");
145: digester.addObjectCreate("*/reports/report/columns",
146: "com.projity.configuration.ReportColumns");
147: digester.addSetProperties("*/reports/report");
148: digester.addSetProperties("*/reports/report/columns");
149: digester.addSetNext("*/reports/report", "add",
150: "com.projity.configuration.NamedItem");
151: digester.addSetNext("*/reports/report/columns", "add",
152: "com.projity.configuration.ReportColumns");
153:
154: }
155:
156: public void add(ReportColumns columns) {
157: columnsList.add(columns);
158: }
159:
160: public String getMainSpreadsheetCategory() {
161: if (columnsList.size() == 0)
162: return null;
163: return ((ReportColumns) columnsList.get(columnsList.size() - 1))
164: .getCategorySpreadSheet();
165: }
166:
167: public SpreadSheetFieldArray getMainFieldArray() {
168: if (columnsList.size() == 0)
169: return null;
170: return ((ReportColumns) columnsList.get(columnsList.size() - 1))
171: .getFieldArray();
172:
173: }
174:
175: public final Object getReportObject(ArrayList columns) {
176: if (columns == null)
177: return reportObject;
178: return reportColumnDefinitions.get(columns);
179: }
180:
181: public final void setReportObject(Object reportObject,
182: ArrayList columns) {
183: if (columns == null)
184: this .reportObject = reportObject;
185: else
186: reportColumnDefinitions.put(columns, reportObject);
187: }
188:
189: public String toString() {
190: return name;
191: }
192:
193: /**
194: * @return Returns the file.
195: */
196: public String getFile() {
197: return file;
198: }
199:
200: /**
201: * @param file The file to set.
202: */
203: public void setFile(String file) {
204: this.file = file;
205: }
206: }
|