001    /*
002     * JBoss, Home of Professional Open Source.
003     * Copyright 2008, Red Hat Middleware LLC, and individual contributors
004     * as indicated by the @author tags. See the copyright.txt file in the
005     * distribution for a full listing of individual contributors. 
006     *
007     * This is free software; you can redistribute it and/or modify it
008     * under the terms of the GNU Lesser General Public License as
009     * published by the Free Software Foundation; either version 2.1 of
010     * the License, or (at your option) any later version.
011     *
012     * This software is distributed in the hope that it will be useful,
013     * but WITHOUT ANY WARRANTY; without even the implied warranty of
014     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015     * Lesser General Public License for more details.
016     *
017     * You should have received a copy of the GNU Lesser General Public
018     * License along with this software; if not, write to the Free
019     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021     */
022    package org.jboss.dna.graph.sequencers;
023    
024    import java.util.Set;
025    import org.jboss.dna.common.collection.Problems;
026    import org.jboss.dna.graph.ExecutionContext;
027    import org.jboss.dna.graph.properties.Name;
028    import org.jboss.dna.graph.properties.Path;
029    import org.jboss.dna.graph.properties.Property;
030    
031    /**
032     * @author John Verhaeg
033     */
034    public interface SequencerContext extends ExecutionContext {
035    
036        /**
037         * Return the path of the input node containing the content being sequenced.
038         * 
039         * @return input node's path.
040         */
041        Path getInputPath();
042    
043        /**
044         * Return the set of properties from the input node containing the content being sequenced.
045         * 
046         * @return the input node's properties; never <code>null</code>.
047         */
048        Set<Property> getInputProperties();
049    
050        /**
051         * Return the property with the supplied name from the input node containing the content being sequenced.
052         * 
053         * @param name
054         * @return the input node property, or <code>null</code> if none exists.
055         */
056        Property getInputProperty( Name name );
057    
058        /**
059         * Return the MIME-type of the content being sequenced.
060         * 
061         * @return the MIME-type
062         */
063        String getMimeType();
064    
065        /**
066         * Get an interface that can be used to record various problems, warnings, and errors that are not extreme enough to warrant
067         * throwing exceptions.
068         * 
069         * @return the interface for recording problems; never null
070         */
071        Problems getProblems();
072    }