001: /* ====================================================================
002: * The JRefactory License, Version 1.0
003: *
004: * Copyright (c) 2001 JRefactory. 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
008: * are 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
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by the
021: * JRefactory (http://www.sourceforge.org/projects/jrefactory)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. The names "JRefactory" must not be used to endorse or promote
026: * products derived from this software without prior written
027: * permission. For written permission, please contact seguin@acm.org.
028: *
029: * 5. Products derived from this software may not be called "JRefactory",
030: * nor may "JRefactory" appear in their name, without prior written
031: * permission of Chris Seguin.
032: *
033: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
034: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
035: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
036: * DISCLAIMED. IN NO EVENT SHALL THE CHRIS SEGUIN OR
037: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
038: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
039: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
040: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
041: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
042: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
043: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
044: * SUCH DAMAGE.
045: * ====================================================================
046: *
047: * This software consists of voluntary contributions made by many
048: * individuals on behalf of JRefactory. For more information on
049: * JRefactory, please see
050: * <http://www.sourceforge.org/projects/jrefactory>.
051: */
052: package org.acm.seguin.summary.query;
053:
054: import org.acm.seguin.summary.PackageSummary;
055: import org.acm.seguin.summary.FileSummary;
056: import org.acm.seguin.summary.TypeSummary;
057: import java.util.Iterator;
058: import java.util.LinkedList;
059:
060: /**
061: * Determines if a package contains a certain type
062: *
063: *@author Chris Seguin
064: *@created November 22, 1999
065: */
066: public abstract class TypeList {
067: /**
068: * Places the query
069: *
070: *@param packageName the name of the package
071: *@return the list of types
072: */
073: public LinkedList query(String packageName) {
074: return query(PackageSummary.getPackageSummary(packageName));
075: }
076:
077: /**
078: * Places the query
079: *
080: *@param summary the package summary
081: *@return the list of types
082: */
083: public LinkedList query(PackageSummary summary) {
084: LinkedList list = new LinkedList();
085:
086: Iterator iter = summary.getFileSummaries();
087: if (iter != null) {
088: while (iter.hasNext()) {
089: FileSummary fileSummary = (FileSummary) iter.next();
090:
091: if (isIncluded(fileSummary)) {
092: add(fileSummary, list);
093: }
094: }
095: }
096:
097: return list;
098: }
099:
100: /**
101: * Determines if the types in the file should be included or not
102: *
103: *@param summary the summary to check
104: *@return true if it should be included
105: */
106: protected abstract boolean isIncluded(FileSummary summary);
107:
108: /**
109: * Determines if the types in the file should be included or not
110: *
111: *@param summary the summary to check
112: *@return true if it should be included
113: */
114: protected abstract boolean isIncluded(TypeSummary summary);
115:
116: /**
117: * Adds the type in a certain file
118: *
119: *@param summary the file summary
120: *@param list the linked list to add to
121: */
122: private void add(FileSummary summary, LinkedList list) {
123: Iterator iter = summary.getTypes();
124: if (iter != null) {
125: while (iter.hasNext()) {
126: TypeSummary typeSummary = (TypeSummary) iter.next();
127: if (isIncluded(typeSummary)) {
128: list.add(typeSummary.getName());
129: }
130: }
131: }
132: }
133: }
|