001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.io.wrappers;
031
032import java.io.DataInput;
033import java.io.DataOutput;
034import java.io.IOException;
035
036import org.openimaj.io.ReadWriteableBinary;
037import org.openimaj.util.pair.IndependentPair;
038
039/**
040 * Base class for writing any independent pair.
041 * 
042 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
043 *
044 * @param <A> Type of first object
045 * @param <B> Type of second object
046 */
047public abstract class ReadWritableIndependentPair<A, B> extends IndependentPair<A, B> implements ReadWriteableBinary {
048        /**
049         * initialise with data
050         * @param obj1
051         * @param obj2
052         */
053        public ReadWritableIndependentPair(A obj1, B obj2) {
054                super(obj1, obj2);
055        }
056        
057        /**
058         * initialise with an existing pair
059         * @param pair
060         */
061        public ReadWritableIndependentPair(IndependentPair<A,B> pair) {
062                super(pair.firstObject(), pair.secondObject());
063        }
064        
065        @Override
066        public void readBinary(DataInput in) throws IOException {
067                this.setFirstObject(readFirst(in));
068                this.setSecondObject(readSecond(in));
069        }
070        
071        /**
072         * @param in
073         * @return first object read from in
074         * @throws IOException 
075         */
076        public abstract A readFirst(DataInput in) throws IOException;
077        
078        /**
079         * @param in
080         * @return second object read from in
081         * @throws IOException 
082         */
083        public abstract B readSecond(DataInput in) throws IOException;
084        
085        /**
086         * first object written to out
087         * @param out 
088         * @param firstObject 
089         * @throws IOException 
090         */
091        public abstract void writeFirst(DataOutput out, A firstObject) throws IOException;
092        
093        /**
094         * second object written to out
095         * @param out 
096         * @param secondObject 
097         * @throws IOException 
098         */
099        public abstract void writeSecond(DataOutput out, B secondObject) throws IOException;
100        
101        @Override
102        public byte[] binaryHeader() {
103                return "RWIP".getBytes();
104        }
105        
106        @Override
107        public void writeBinary(DataOutput out) throws IOException {
108                writeFirst(out, this.firstObject());
109                writeSecond(out, this.secondObject());
110        }
111}