/*******************************************************************************
 * Copyright 2016 Stephan Druskat 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Contributors:
 *     Stephan Druskat - initial API and implementation
 *******************************************************************************/
package org.corpus_tools.atomic.extensions;

import de.hu_berlin.german.korpling.saltnpepper.salt.saltCommon.sCorpusStructure.SDocument;

/**
 * A processing component is a component (usually an NLP component)
 * that - abstractly put - manipulates a corpus. In terms of types,
 * implementations of {@link ProcessingComponent}s take an instance
 * of {@link SDocument} and manipulate it. The manipulation will
 * usually be made on the {@link SDocument}'s {@link SDocumentGraph},
 * but can also be made on the {@link SDocument} itself.
 * <p>
 * The formal type parameters define the input type and output type used 
 * to restrict parameter and return values for methods customized for
 * specific processing component types. Cf., for example, the
 * abstract classes in sub-package <i>processingcomponent</i> of
 * this package.
 * <p>
 * Note that <b>clients should not implement this interface directly</b>, 
 * but instead extend one of the abstract classes in package 
 * org.corpus_tools.atomic.extensions.processingcomponents.
 * <p>
 * <i>Acknowledgements:</i> I'd like to thank Thomas Krause for pointing
 * me in the right direction concerning the type structure for this 
 * functionality.
 *
 * @author Stephan Druskat <mail@sdruskat.net>
 *
 */
public interface ProcessingComponent<InputType, OutputType> {

	/**
	 * Manipulates a given {@link SDocument}. The term "manipulation"
	 * in this context is unrestricted, i.e., it can mean diverse
	 * types of manipulation from partition detection to parsing.
	 *
	 * @param document The document to process
	 */
	public void processDocument(SDocument document);
	
}

@@ -1370,16 +1370,582 @@
 %0A * %3Cp%3E%0A
+ * %7B@link ProcessingComponent%7Ds need a name, a description, and a unique,%0A * path-style ID, where%0A * %3Cul%3E%0A * %3Cli%3Ethe %3Cb%3Ename%3C/b%3E will be used in GUIs to let the user identify%0A * the component and its functionality, e.g., %22TreeTagger-like Tokenizer%22;%3C/li%3E%0A * %3Cli%3Ethe %3Cb%3Edescription%3C/b%3E will be used in GUIs to inform the user%0A * about the functionality of the component, in a brief but comprehensive%0A * manner;%3C/li%3E%0A * %3Cli%3Ethe %3Cb%3Eunique ID%3C/b%3E may be used in APIs to identify the component,%0A * e.g., %22org.corpus_tools.tokenizers.treetaggerlike%22.%3C/li%3E%0A * %3C/ul%3E%0A * %3Cp%3E%0A
  * The f
@@ -3018,10 +3018,435 @@
 ent);%0A%09%0A
+%09/**%0A%09 * Returns the component's name.%0A%09 *%0A%09 * @return the components name%0A%09 */%0A%09public String getName();%0A%09%0A%09/**%0A%09 * Returns a brief, comprehensive description of the%0A%09 * component's functionality.%0A%09 *%0A%09 * @return the component's description%0A%09 */%0A%09public String getDescription();%0A%09%0A%09/**%0A%09 * Returns the unique, path-like identifier for%0A%09 * the component.%0A%09 *%0A%09 * @return the unique identifier%0A%09 */%0A%09public String getUID();%0A%09%0A
 %7D%0A

Update ProcessingComponent to include name, description, id