001: // ============================================================================
002: // $Id: Merge.java,v 1.6 2006/02/10 04:44:59 davidahall Exp $
003: // Copyright (c) 2003-2005 David A. Hall
004: // ============================================================================
005: // The contents of this file are subject to the Common Development and
006: // Distribution License (CDDL), Version 1.0 (the License); you may not use this
007: // file except in compliance with the License. You should have received a copy
008: // of the the License along with this file: if not, a copy of the License is
009: // available from Sun Microsystems, Inc.
010: //
011: // http://www.sun.com/cddl/cddl.html
012: //
013: // From time to time, the license steward (initially Sun Microsystems, Inc.) may
014: // publish revised and/or new versions of the License. You may not use,
015: // distribute, or otherwise make this file available under subsequent versions
016: // of the License.
017: //
018: // Alternatively, the contents of this file may be used under the terms of the
019: // GNU Lesser General Public License Version 2.1 or later (the "LGPL"), in which
020: // case the provisions of the LGPL 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: // LGPL, and not to allow others to use your version of this file under the
023: // terms of the CDDL, indicate your decision by deleting the provisions above
024: // and replace them with the notice and other provisions required by the LGPL.
025: // If you do not delete the provisions above, a recipient may use your version
026: // of this file under the terms of either the CDDL or the LGPL.
027: //
028: // This library is distributed in the hope that it will be useful,
029: // but WITHOUT ANY WARRANTY; without even the implied warranty of
030: // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
031: // ============================================================================
032: package net.sf.jga.fn.algorithm;
033:
034: import java.util.Comparator;
035: import java.util.Iterator;
036: import net.sf.jga.fn.BinaryFunctor;
037: import net.sf.jga.util.MergeIterator;
038:
039: /**
040: * Returns an iterator based on the two input iterators that will merge their
041: * contents. If the contents of both input iterators are sorted, then the
042: * iterator returned will be sorted as well.
043: * <p>
044: * To serialize a Merge, the comparator passed at construction must be
045: * Serializable.
046: * <p>
047: * Copyright © 2003-2005 David A. Hall
048: * @deprecated
049: */
050:
051: public class Merge<T>
052: extends
053: BinaryFunctor<Iterator<? extends T>, Iterator<? extends T>, MergeIterator<T>> {
054: static final long serialVersionUID = 1680420131592467899L;
055:
056: private Comparator<T> _comp;
057:
058: /**
059: * Builds an Merge functor that will use the given comparator to compare
060: * corresponding elements of two input iterators..
061: * @throws IllegalArgumentException if the test is null
062: */
063: public Merge(Comparator<T> comp) {
064: if (comp == null)
065: throw new IllegalArgumentException();
066:
067: _comp = comp;
068: }
069:
070: /**
071: * Returns the functor used to process elements in an iteration.
072: */
073: public Comparator<T> getComparator() {
074: return _comp;
075: }
076:
077: /**
078: * Apply the functor to each element in the iteration and return an iterator
079: * over the results
080: *
081: * @return an iterator over the results of the transformation
082: */
083: public MergeIterator<T> fn(Iterator<? extends T> iter1,
084: Iterator<? extends T> iter2) {
085: return new MergeIterator<T>(iter1, iter2, _comp);
086: }
087:
088: /**
089: * Calls the Visitor's <code>visit(Merge)</code> method, if it
090: * implements the nested Visitor interface.
091: */
092: public void accept(net.sf.jga.fn.Visitor v) {
093: if (v instanceof Merge.Visitor)
094: ((Merge.Visitor) v).visit(this );
095: else
096: v.visit(this );
097: }
098:
099: // Object overrides
100:
101: public String toString() {
102: return "Merge";
103: }
104:
105: // AcyclicVisitor
106:
107: /**
108: * Interface for classes that may interpret an <b>Merge</b> functor.
109: */
110: public interface Visitor extends net.sf.jga.fn.Visitor {
111: public void visit(Merge host);
112: }
113: }
|