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.util.function.context;
031
032import org.openimaj.util.data.Context;
033import org.openimaj.util.function.Function;
034
035/**
036 * Generate a context stream from a stream of other objects.
037 * 
038 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
039 * 
040 * @param <T>
041 *            Type of input objects
042 */
043public class ContextGenerator<T> implements Function<T, Context> {
044        private ContextInsertor<T> insert;
045
046        /**
047         * Construct with the given insertor.
048         * 
049         * @param insert
050         *            the insertor
051         */
052        public ContextGenerator(ContextInsertor<T> insert) {
053                this.insert = insert;
054        }
055
056        /**
057         * Construct with the given key, which is used to create a
058         * {@link KeyContextInsertor}.
059         * 
060         * @param key
061         *            the key to extract (a {@link KeyContextInsertor} is
062         *            used)
063         */
064        public ContextGenerator(String key) {
065                this.insert = new KeyContextInsertor<T>(key);
066        }
067
068        @Override
069        public Context apply(T in) {
070                final Context c = new Context();
071
072                this.insert.insert(in, c);
073
074                return c;
075        }
076}