tracefw/tracecompiler/src/com.nokia.tracecompiler/src/com/nokia/tracecompiler/project/TraceLocationParser.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tracefw/tracecompiler/src/com.nokia.tracecompiler/src/com/nokia/tracecompiler/project/TraceLocationParser.java Mon Aug 23 15:29:36 2010 +0300
@@ -0,0 +1,91 @@
+/*
+* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+* Interface to location parser
+*
+*/
+package com.nokia.tracecompiler.project;
+
+import com.nokia.tracecompiler.engine.TraceLocation;
+import com.nokia.tracecompiler.engine.TraceCompilerEngineErrorCodes.TraceCompilerErrorCode;
+import com.nokia.tracecompiler.engine.source.SourceParserRule.TraceConversionResult;
+import com.nokia.tracecompiler.model.TraceCompilerException;
+import com.nokia.tracecompiler.source.SourceExcludedArea;
+
+/**
+ * Interface to location parser. The parser is implemented into the project API
+ *
+ */
+public interface TraceLocationParser {
+
+ /**
+ * Processes a newly parsed location. The location has not yet been
+ * associated with a trace.
+ *
+ * @param location
+ * the new location
+ */
+ public void processNewLocation(TraceLocation location);
+
+ /**
+ * Gets the group where locations created by this parser belong
+ *
+ * @return the location group
+ */
+ public String getLocationGroup();
+
+ /**
+ * Converts a location to trace
+ *
+ * @param location
+ * the location to be parsed
+ * @return properties for new trace
+ * @throws TraceCompilerException
+ * if the location cannot be converted
+ */
+ public TraceConversionResult convertLocation(TraceLocation location)
+ throws TraceCompilerException;
+
+ /**
+ * Finds the comment related to given location
+ *
+ * @param location
+ * the location to be checked
+ * @return the comment related to the location or null if not found
+ */
+ public SourceExcludedArea findLocationComment(TraceLocation location);
+
+ /**
+ * Determines if a location parsed from source should be automatically
+ * converted to a trace. This is called only if
+ * isLocationAutoConvertSupported has returned true
+ *
+ * @param location
+ * the location to be checked
+ *
+ * @return true if automatically converted, false if not
+ */
+ public boolean isLocationConverted(TraceLocation location);
+
+ /**
+ * Checks if a location matches its trace
+ *
+ * @param location
+ * the location to be checked
+ * @return error code from TraceCompilerErrorCodes
+ */
+ public TraceCompilerErrorCode checkLocationValidity(TraceLocation location);
+
+}