X-Git-Url: http://drtracing.org/?a=blobdiff_plain;f=org.eclipse.linuxtools.tmf.ui%2Fsrc%2Forg%2Feclipse%2Flinuxtools%2Ftmf%2Fui%2Fparsers%2FIParserProvider.java;h=c47964c0bf2dacb8b978f15a3aedff5ceab52087;hb=90e2b925f92cd3476c56cbce7a862a4c2db386c0;hp=099653272da9165b66850ef41cff240a07dd0ff3;hpb=ca13a91c80a4e2260e81ec723a07ca673ad260b4;p=deliverable%2Ftracecompass.git

diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/parsers/IParserProvider.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/parsers/IParserProvider.java
index 099653272d..c47964c0bf 100644
--- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/parsers/IParserProvider.java
+++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/parsers/IParserProvider.java
@@ -21,16 +21,75 @@ import org.eclipse.swt.widgets.Composite;
 
 public interface IParserProvider {
 
+	/**
+	 * Return the readable category name for this parser provider
+	 * 
+	 * @return the category name
+	 */
     public String getCategory();
     
+	/**
+	 * Return a trace instance for a resource given a parser id
+	 * 
+	 * @param parser the parser id
+	 * @param resource the resource
+	 * @return a trace instance or null if the parser id is not handled by this parser provider
+	 */
     public ITmfTrace getTraceForParser(String parser, IResource resource);
     
+	/**
+	 * Return a trace instance for a resource given a content type id
+	 * 
+	 * @param contentTypeId the content type id
+	 * @param resource the resource
+	 * @return a trace instance or null if the content type id is not handled by this parser provider
+	 */
     public ITmfTrace getTraceForContentType(String contentTypeId, IResource resource);
     
-    public String getEditorIdForParser(String parser);
-    
+	/**
+	 * Return the parser map for this parser provider
+	 * Map key: readable parser name
+	 * Map value: unique parser id
+	 * 
+	 * @return the parser map
+	 */
     public Map<String, String> getParserMap();
 
+	/**
+	 * Return the event type map given a parser id
+	 * Map key: readable event type name
+	 * Map value: unique event type id
+	 * 
+	 * @param parser the parser id
+	 * @return the event type map or null if the parser id is not handled by this parser provider
+	 */
+    public Map<String, String> getEventTypeMapForParser(String parser);
+    
+	/**
+	 * Return the field label array given an event type id
+	 * Array value: readable field label
+	 * 
+	 * @param eventType the event type id
+	 * @return the field label array or null if the event type id is not handled by this parser provider
+	 */
+    public String[] getFieldLabelsForEventType(String eventType);
+    
+	/**
+	 * Return the editor id given a parser id
+	 * 
+	 * @param parser the parser id
+	 * @return an editor id or null to use the default trace editor
+	 */
+    public String getEditorIdForParser(String parser);
+
+	/**
+	 * Return an events table instance for a given trace
+	 * 
+	 * @param parser the parser id
+	 * @param parent the parent composite for the table
+	 * @param cacheSize the desired cache size for the table
+	 * @return an events table instance or null if the trace is not handled by this parser provider
+	 */
     public TmfEventsTable getEventsTable(ITmfTrace trace, Composite parent, int cacheSize);
 
 }