Fix HistogramView recounts on range update

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / parsers / IParserProvider.java

/*******************************************************************************\r
 * Copyright (c) 2010 Ericsson\r
 * \r
 * All rights reserved. This program and the accompanying materials are\r
 * made available under the terms of the Eclipse Public License v1.0 which\r
 * accompanies this distribution, and is available at\r
 * http://www.eclipse.org/legal/epl-v10.html\r
 * \r
 * Contributors:\r
 *   Patrick Tasse - Initial API and implementation\r
 *******************************************************************************/\r
\r
package org.eclipse.linuxtools.tmf.ui.parsers;\r
\r
import java.util.Map;\r
\r
import org.eclipse.core.resources.IResource;\r
import org.eclipse.linuxtools.tmf.trace.ITmfTrace;\r
import org.eclipse.linuxtools.tmf.ui.viewers.events.TmfEventsTable;\r
import org.eclipse.swt.widgets.Composite;\r
\r
public interface IParserProvider {\r
\r
	/**\r
	 * Return the readable category name for this parser provider\r
	 * \r
	 * @return the category name\r
	 */\r
    public String getCategory();\r
    \r
	/**\r
	 * Return a trace instance for a resource given a parser id\r
	 * \r
	 * @param parser the parser id\r
	 * @param resource the resource\r
	 * @return a trace instance or null if the parser id is not handled by this parser provider\r
	 */\r
    public ITmfTrace<?> getTraceForParser(String parser, IResource resource);\r
    \r
	/**\r
	 * Return a trace instance for a resource given a content type id\r
	 * \r
	 * @param contentTypeId the content type id\r
	 * @param resource the resource\r
	 * @return a trace instance or null if the content type id is not handled by this parser provider\r
	 */\r
    public ITmfTrace<?> getTraceForContentType(String contentTypeId, IResource resource);\r
    \r
	/**\r
	 * Return the parser map for this parser provider\r
	 * Map key: readable parser name\r
	 * Map value: unique parser id\r
	 * \r
	 * @return the parser map\r
	 */\r
    public Map<String, String> getParserMap();\r
\r
	/**\r
	 * Return the event type map given a parser id\r
	 * Map key: readable event type name\r
	 * Map value: unique event type id\r
	 * \r
	 * @param parser the parser id\r
	 * @return the event type map or null if the parser id is not handled by this parser provider\r
	 */\r
    public Map<String, String> getEventTypeMapForParser(String parser);\r
    \r
	/**\r
	 * Return the field label array given an event type id\r
	 * Array value: readable field label\r
	 * \r
	 * @param eventType the event type id\r
	 * @return the field label array or null if the event type id is not handled by this parser provider\r
	 */\r
    public String[] getFieldLabelsForEventType(String eventType);\r
    \r
	/**\r
	 * Return the editor id given a parser id\r
	 * \r
	 * @param parser the parser id\r
	 * @return an editor id or null to use the default trace editor\r
	 */\r
    public String getEditorIdForParser(String parser);\r
\r
	/**\r
	 * Return an events table instance for a given trace\r
	 * \r
	 * @param parser the parser id\r
	 * @param parent the parent composite for the table\r
	 * @param cacheSize the desired cache size for the table\r
	 * @return an events table instance or null if the trace is not handled by this parser provider\r
	 */\r
    public TmfEventsTable getEventsTable(ITmfTrace<?> trace, Composite parent, int cacheSize);\r
\r
}\r