001: package org.tigris.scarab.om;
002:
003: /* ================================================================
004: * Copyright (c) 2000-2005 CollabNet. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions are
008: * met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in the
015: * documentation and/or other materials provided with the distribution.
016: *
017: * 3. The end-user documentation included with the redistribution, if
018: * any, must include the following acknowlegement: "This product includes
019: * software developed by Collab.Net <http://www.Collab.Net/>."
020: * Alternately, this acknowlegement may appear in the software itself, if
021: * and wherever such third-party acknowlegements normally appear.
022: *
023: * 4. The hosted project names must not be used to endorse or promote
024: * products derived from this software without prior written
025: * permission. For written permission, please contact info@collab.net.
026: *
027: * 5. Products derived from this software may not use the "Tigris" or
028: * "Scarab" names nor may "Tigris" or "Scarab" appear in their names without
029: * prior written permission of Collab.Net.
030: *
031: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
032: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
033: * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
034: * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
035: * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
036: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
037: * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
038: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
039: * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
040: * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
041: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
042: *
043: * ====================================================================
044: *
045: * This software consists of voluntary contributions made by many
046: * individuals on behalf of Collab.Net.
047: */
048:
049: import org.apache.commons.lang.ObjectUtils;
050: import org.apache.torque.TorqueException;
051: import org.apache.torque.om.Persistent;
052: import org.apache.torque.util.Criteria;
053: import org.tigris.scarab.tools.localization.L10NKeySet;
054: import org.tigris.scarab.util.ScarabException;
055: import org.tigris.scarab.util.word.IssueSearch;
056: import org.tigris.scarab.util.word.IssueSearchFactory;
057: import org.tigris.scarab.util.word.MaxConcurrentSearchException;
058:
059: import com.workingdogs.village.DataSetException;
060:
061: /**
062: * A module and an issue type. Wildcards are possible, so that a single
063: * MITListItem could represent all the issue types in a module. A single
064: * issue type in all modules (that have it defined). Or all modules and
065: * issue types.
066: */
067: public class MITListItem extends BaseMITListItem implements Persistent {
068: static final Integer MULTIPLE_KEY = new Integer(0);
069:
070: /**
071: * The number of active issues of the this issue type within the module.
072: *
073: * @param user a <code>ScarabUser</code> value used to determine if
074: * a count should be given.
075: * @return an <code>int</code> the number of issues entered for the
076: * module unless the user does not have permission to
077: * search for issues in the given module, then a value of 0 will be
078: * returned. if resource limited, this method will return -1.
079: * @exception Exception if an error occurs
080: */
081: public int getIssueCount(ScarabUser user) throws TorqueException,
082: ScarabException {
083: IssueSearch is = null;
084: int count = 0;
085: try {
086: is = IssueSearchFactory.INSTANCE.getInstance(getModule(),
087: getIssueType(), user);
088: count = is.getIssueCount();
089: } catch (MaxConcurrentSearchException e) {
090: count = -1;
091: } catch (Exception e) {
092: throw new ScarabException(L10NKeySet.ExceptionGeneral, e);
093: } finally {
094: IssueSearchFactory.INSTANCE.notifyDone();
095: }
096: return count;
097: }
098:
099: /**
100: * The number of active issues of the this issue type within the module.
101: *
102: * @param user a <code>ScarabUser</code> value used to determine if
103: * a count should be given.
104: * @return an <code>int</code> the number of issues entered for the
105: * module unless the user does not have permission to
106: * search for issues in the given module, then a value of 0 will be
107: * returned. if resource limited, this method will return -1.
108: * @throws DataSetException
109: * @exception Exception if an error occurs
110: */
111: public int getIssueCount(ScarabUser user,
112: AttributeOption attributeOption) throws TorqueException,
113: ScarabException, DataSetException {
114: Criteria crit = new Criteria();
115:
116: Integer attributeId = attributeOption.getAttributeId();
117: Integer optionId = attributeOption.getOptionId();
118:
119: crit.add(AttributeValuePeer.ATTRIBUTE_ID, attributeId);
120: crit.add(AttributeValuePeer.OPTION_ID, optionId);
121: crit.add(AttributeValuePeer.DELETED, 0);
122: crit.add(IssuePeer.MODULE_ID, getModuleId());
123: crit.add(IssuePeer.TYPE_ID, this .getIssueTypeId());
124: crit.add(IssuePeer.MOVED, 0);
125: crit.add(IssuePeer.DELETED, 0);
126: crit.addJoin(AttributeValuePeer.ISSUE_ID, IssuePeer.ISSUE_ID);
127:
128: int count = AttributeValuePeer.count(crit);
129: return count;
130: }
131:
132: public boolean isSingleModuleIssueType() {
133: boolean single = true;
134: if (MULTIPLE_KEY.equals(getModuleId())
135: || MULTIPLE_KEY.equals(getIssueTypeId())) {
136: single = false;
137: }
138: return single;
139: }
140:
141: public boolean isSingleModule() {
142: return !MULTIPLE_KEY.equals(getModuleId());
143: }
144:
145: public boolean isSingleIssueType() {
146: return !MULTIPLE_KEY.equals(getIssueTypeId());
147: }
148:
149: public boolean isUseCurrentModule() {
150: return getModuleId() == null;
151: }
152:
153: public String getQueryKey() {
154: String key = super .getQueryKey();
155: if (key == null || key.length() == 0) {
156: StringBuffer sb = new StringBuffer();
157: if (getModuleId() != null) {
158: sb.append(getModuleId());
159: }
160: sb.append(':');
161: if (getIssueTypeId() != null) {
162: sb.append(getIssueTypeId());
163: }
164: key = sb.toString();
165: }
166: return key;
167: }
168:
169: public int hashCode() {
170: int hashCode = 10;
171: if (getModuleId() != null) {
172: hashCode += getModuleId().hashCode();
173: }
174: if (getIssueTypeId() != null) {
175: hashCode += getIssueTypeId().hashCode();
176: }
177: return hashCode;
178: }
179:
180: public boolean equals(Object obj) {
181: boolean isEqual = false;
182: if (obj instanceof MITListItem) {
183: MITListItem item = (MITListItem) obj;
184: isEqual = ObjectUtils.equals(this .getModuleId(), item
185: .getModuleId());
186: isEqual &= ObjectUtils.equals(this .getIssueTypeId(), item
187: .getIssueTypeId());
188: }
189: return isEqual;
190: }
191:
192: public String toString() {
193: StringBuffer sb = new StringBuffer(50);
194: sb.append('{').append(super .toString()).append('(');
195: if (getModuleId() != null) {
196: sb.append(getModuleId());
197: }
198: sb.append(':');
199: if (getIssueTypeId() != null) {
200: sb.append(getIssueTypeId());
201: }
202: sb.append(")}");
203:
204: return sb.toString();
205: }
206: }
|