KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > tigris > scarab > om > IssuePeer


1 package org.tigris.scarab.om;
2
3 /* ================================================================
4  * Copyright (c) 2000-2002 CollabNet. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in the
15  * documentation and/or other materials provided with the distribution.
16  *
17  * 3. The end-user documentation included with the redistribution, if
18  * any, must include the following acknowlegement: "This product includes
19  * software developed by Collab.Net <http://www.Collab.Net/>."
20  * Alternately, this acknowlegement may appear in the software itself, if
21  * and wherever such third-party acknowlegements normally appear.
22  *
23  * 4. The hosted project names must not be used to endorse or promote
24  * products derived from this software without prior written
25  * permission. For written permission, please contact info@collab.net.
26  *
27  * 5. Products derived from this software may not use the "Tigris" or
28  * "Scarab" names nor may "Tigris" or "Scarab" appear in their names without
29  * prior written permission of Collab.Net.
30  *
31  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
32  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
33  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
34  * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
35  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
37  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
39  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
40  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42  *
43  * ====================================================================
44  *
45  * This software consists of voluntary contributions made by many
46  * individuals on behalf of Collab.Net.
47  */
48
49 // Turbine classes
50 import org.apache.torque.TorqueException;
51 import org.apache.torque.om.ObjectKey;
52 import org.apache.torque.util.Criteria;
53 import com.workingdogs.village.Record;
54 import com.workingdogs.village.DataSetException;
55
56 // Scarab classes
57 import org.tigris.scarab.services.cache.ScarabCache;
58
59 /**
60  * The Peer class for an issue.
61  *
62  * @author <a HREF="mailto:jmcnally@collab.net">John McNally</a>
63  * @author <a HREF="mailto:jon@collab.net">Jon S. Stevens</a>
64  * @author <a HREF="mailto:elicia@collab.net">Elicia David</a>
65  * @version $Id: IssuePeer.java 9255 2004-11-14 21:07:04Z dep4b $
66  */
67 public class IssuePeer
68     extends org.tigris.scarab.om.BaseIssuePeer
69 {
70     private static final String JavaDoc ISSUE_PEER =
71         "IssuePeer";
72     private static final String JavaDoc RETRIEVE_BY_PK =
73         "retrieveByPK";
74
75     private static final String JavaDoc COUNT =
76         "count(" + ISSUE_ID + ')';
77     private static final String JavaDoc COUNT_DISTINCT =
78         "count(DISTINCT " + ISSUE_ID + ')';
79
80     /**
81      * Adds count(IssuePeer.ISSUE_ID) to the select clause and returns the
82      * number of rows resulting from the given Criteria. If the criteria will
83      * lead to duplicate ISSUE_ID's they will be counted. However, if the
84      * criteria is known not to lead to this, or unique ISSUE_ID's are not
85      * required, this method is cheaper than {@link #countDistinct(Criteria)}
86      *
87      * @param crit a <code>Criteria</code> value
88      * @return an <code>int</code> value
89      * @exception TorqueException if an error occurs
90      * @exception DataSetException if an error occurs
91      */
92     public static int count(Criteria crit)
93         throws TorqueException, DataSetException
94     {
95         crit.addSelectColumn(COUNT);
96         return ((Record)IssuePeer.doSelectVillageRecords(crit).get(0))
97             .getValue(1).asInt();
98     }
99
100     /**
101      * Adds count(DISTINCT IssuePeer.ISSUE_ID) to the select clause and returns
102      * the number of rows resulting from the given Criteria. The returned
103      * value will be the number of unique ISSUE_ID's.
104      *
105      * @param crit a <code>Criteria</code> value
106      * @return an <code>int</code> value
107      * @exception TorqueException if an error occurs
108      * @exception DataSetException if an error occurs
109      */
110     public static int countDistinct(Criteria crit)
111         throws TorqueException, DataSetException
112     {
113         crit.addSelectColumn(COUNT_DISTINCT);
114         return ((Record)IssuePeer.doSelectVillageRecords(crit).get(0))
115             .getValue(1).asInt();
116     }
117
118     /**
119      * Retrieve a single object by pk
120      *
121      * @param pk
122      */
123     public static Issue retrieveByPK(ObjectKey pk)
124         throws TorqueException
125     {
126         Issue result = null;
127         Object JavaDoc obj = ScarabCache.get(ISSUE_PEER, RETRIEVE_BY_PK, pk);
128         if (obj == null)
129         {
130             result = BaseIssuePeer.retrieveByPK(pk);
131             ScarabCache.put(result, ISSUE_PEER, RETRIEVE_BY_PK, pk);
132         }
133         else
134         {
135             result = (Issue)obj;
136         }
137         
138         result = BaseIssuePeer.retrieveByPK(pk);
139         return result;
140     }
141 }
142
Popular Tags