Clover coverage report - Code Coverage for hivemind release 1.0-beta-2
Coverage timestamp: Sun Aug 1 2004 14:03:45 EDT
file stats: LOC: 96   Methods: 0
NCLOC: 15   Classes: 1
30 day Evaluation Version distributed via the Maven Jar Repository. Clover is not free. You have 30 days to evaluate it. Please visit http://www.thecortex.net/clover to obtain a licensed version of Clover
 
 Source file Conditionals Statements Methods TOTAL
SchemaProcessor.java - - - -
coverage
 1   
 //  Copyright 2004 The Apache Software Foundation
 2   
 //
 3   
 // Licensed under the Apache License, Version 2.0 (the "License");
 4   
 // you may not use this file except in compliance with the License.
 5   
 // You may obtain a copy of the License at
 6   
 //
 7   
 //     http://www.apache.org/licenses/LICENSE-2.0
 8   
 //
 9   
 // Unless required by applicable law or agreed to in writing, software
 10   
 // distributed under the License is distributed on an "AS IS" BASIS,
 11   
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 12   
 // See the License for the specific language governing permissions and
 13   
 // limitations under the License.
 14   
 
 15   
 package org.apache.hivemind.schema;
 16   
 
 17   
 import org.apache.hivemind.internal.Module;
 18   
 
 19   
 /**
 20   
  * Object used when processing the elements contributed
 21   
  * in an {@link org.apache.hivemind.Contribution}.
 22   
  *
 23   
  * @author Howard Lewis Ship
 24   
  */
 25   
 public interface SchemaProcessor
 26   
 {
 27   
     /**
 28   
      * The SchemaProcessor is always the bottom (deepest) object on the stack.
 29   
      * Top level objects (contained by a schema, not another element)
 30   
      * can use an {@link org.apache.hivemind.schema.rules.InvokeParentRule}
 31   
      * to add themselves to the list of elements for the
 32   
      * {@link org.apache.hivemind.ConfigurationPoint} being constructed.
 33   
      */
 34   
     public void addElement(Object element);
 35   
 
 36   
     /**
 37   
      * Pushes an object onto the processor's stack.
 38   
      */
 39   
     public void push(Object object);
 40   
 
 41   
     /**
 42   
      * Pops the top object off the stack and returns it.
 43   
      */
 44   
 
 45   
     public Object pop();
 46   
 
 47   
     /**
 48   
      * Peeks at the top object on the stack.
 49   
      * 
 50   
      **/
 51   
 
 52   
     public Object peek();
 53   
 
 54   
     /**
 55   
      * Peeks at an object within the stack at the indicated depth.
 56   
      */
 57   
 
 58   
     public Object peek(int depth);
 59   
 
 60   
     /**
 61   
      * Returns the module which contributed the current elements being processed.
 62   
      * 
 63   
      **/
 64   
 
 65   
     public Module getContributingModule();
 66   
 
 67   
     /**
 68   
      * Returns the path to the current element in the form a sequence
 69   
      * of element names separated with slashes.  This is most often
 70   
      * used in error messages, to help identify the position of
 71   
      * an error.
 72   
      */
 73   
 
 74   
     public String getElementPath();
 75   
 
 76   
     /**
 77   
      * Returns a {@link org.apache.hivemind.schema.Translator} used to convert
 78   
      * the content of the current element. Will not return null.
 79   
      */
 80   
 
 81   
     public Translator getContentTranslator();
 82   
 
 83   
     /**
 84   
      * Returns the {@link org.apache.hivemind.schema.Translator} for a particular
 85   
      * attribute of the current element. Will not return null.
 86   
      */
 87   
 
 88   
     public Translator getAttributeTranslator(String attributeName);
 89   
     
 90   
     /**
 91   
      * Returns the named {@link org.apache.hivemind.schema.Translator}.
 92   
      */
 93   
     
 94   
     public Translator getTranslator(String translator);
 95   
 }
 96