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.util.Logger;
026 import org.jboss.dna.graph.properties.Name;
027 import org.jboss.dna.graph.properties.NamespaceRegistry;
028 import org.jboss.dna.graph.properties.Path;
029 import org.jboss.dna.graph.properties.Property;
030 import org.jboss.dna.graph.properties.ValueFactories;
031
032 /**
033 * @author John Verhaeg
034 */
035 public interface SequencerContext {
036
037 /**
038 * Get the factories that can be used to create {@link Path paths} and other property values.
039 *
040 * @return the collection of factories; never <code>null</code>.
041 */
042 ValueFactories getFactories();
043
044 /**
045 * Return the path of the input node containing the content being sequenced.
046 *
047 * @return input node's path.
048 */
049 Path getInputPath();
050
051 /**
052 * Return the set of properties from the input node containing the content being sequenced.
053 *
054 * @return the input node's properties; never <code>null</code>.
055 */
056 Set<Property> getInputProperties();
057
058 /**
059 * Return the property with the supplied name from the input node containing the content being sequenced.
060 *
061 * @param name
062 * @return the input node property, or <code>null</code> if none exists.
063 */
064 Property getInputProperty( Name name );
065
066 /**
067 * Return the MIME-type of the content being sequenced.
068 *
069 * @return the MIME-type
070 */
071 String getMimeType();
072
073 /**
074 * Convenience method to get the namespace registry used by the {@link ValueFactories#getNameFactory() name value factory}.
075 *
076 * @return the namespace registry; never <code>null</code>.
077 */
078 NamespaceRegistry getNamespaceRegistry();
079
080 /**
081 * Return a logger associated with this context. This logger records only those activities within the context and provide a
082 * way to capture the context-specific activities. All log messages are also sent to the system logger, so classes that log
083 * via this mechanism should <i>not</i> also {@link Logger#getLogger(Class) obtain a system logger}.
084 *
085 * @param clazz the class that is doing the logging
086 * @return the logger, named after <code>clazz</code>; never null
087 * @see #getLogger(String)
088 */
089 Logger getLogger( Class<?> clazz );
090
091 /**
092 * Return a logger associated with this context. This logger records only those activities within the context and provide a
093 * way to capture the context-specific activities. All log messages are also sent to the system logger, so classes that log
094 * via this mechanism should <i>not</i> also {@link Logger#getLogger(Class) obtain a system logger}.
095 *
096 * @param name the name for the logger
097 * @return the logger, named after <code>clazz</code>; never null
098 * @see #getLogger(Class)
099 */
100 Logger getLogger( String name );
101
102 }