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.math.geometry.point;
031
032import java.io.DataInput;
033import java.io.DataOutput;
034import java.io.IOException;
035import java.io.PrintWriter;
036import java.util.Scanner;
037
038/**
039 * A concrete implementation of a {@link Coordinate} that
040 * has an associated payload.
041 * 
042 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
043 *
044 * @param <T> Type of underlying coordinate
045 * @param <O> Type of payload data
046 */
047public class PayloadCoordinate<T extends Coordinate, O> implements Coordinate {
048        
049        private T coord;
050        private O payload;
051        
052        /**
053         * Construct with coordinate and payload.
054         * @param coord The coordinate.
055         * @param payload The payload.
056         */
057        public PayloadCoordinate(T coord, O payload){
058                this.coord = coord;
059                this.setPayload(payload);
060        }
061        
062        @Override
063        public void readASCII(Scanner in) throws IOException { coord.readASCII(in);}
064        @Override
065        public String asciiHeader() {return coord.asciiHeader();}
066
067        @Override
068        public void readBinary(DataInput in) throws IOException {coord.readBinary(in);}
069
070        @Override
071        public byte[] binaryHeader() { return coord.binaryHeader();}
072
073        @Override
074        public void writeASCII(PrintWriter out) throws IOException {coord.writeASCII(out);}
075
076        @Override
077        public void writeBinary(DataOutput out) throws IOException {coord.writeBinary(out);}
078
079        @Override
080        public Number getOrdinate(int dimension) {return coord.getOrdinate(dimension);}
081
082        @Override
083        public int getDimensions() {return coord.getDimensions();}
084
085        /**
086         * Set the payload.
087         * @param payload The payload
088         */
089        public void setPayload(O payload) {
090                this.payload = payload;
091        }
092
093        /**
094         * @return The payload.
095         */
096        public O getPayload() {
097                return payload;
098        }
099
100        /**
101         * Create a {@link PayloadCoordinate}.
102         * @param <T> The coordinate type.
103         * @param <O> The payload type.
104         * @param coord The coordinate.
105         * @param payload The payload.
106         * @return the newly created {@link PayloadCoordinate}.
107         */
108        public static <T extends Coordinate, O> PayloadCoordinate<T,O> payload(T coord,O payload) {
109                return new PayloadCoordinate<T,O>(coord,payload);
110        }
111}