sysperfana/heapanalyser/Libraries/Engine/HeapLib/Reconstructor/DataSources/Analyser/Extractor/Base/Extractor.cs
changeset 8 15296fd0af4a
equal deleted inserted replaced
7:8e12a575a9b5 8:15296fd0af4a
       
     1 /*
       
     2 * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 *
       
     5 * Redistribution and use in source and binary forms, with or without
       
     6 * modification, are permitted provided that the following conditions are met:
       
     7 *
       
     8 * - Redistributions of source code must retain the above copyright notice,
       
     9 *   this list of conditions and the following disclaimer.
       
    10 * - Redistributions in binary form must reproduce the above copyright notice,
       
    11 *   this list of conditions and the following disclaimer in the documentation
       
    12 *   and/or other materials provided with the distribution.
       
    13 * - Neither the name of Nokia Corporation nor the names of its contributors
       
    14 *   may be used to endorse or promote products derived from this software
       
    15 *   without specific prior written permission.
       
    16 *
       
    17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
       
    18 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
       
    19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
       
    20 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
       
    21 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
       
    22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
       
    23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
       
    24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
       
    25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
       
    26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
       
    27 * POSSIBILITY OF SUCH DAMAGE.
       
    28 * 
       
    29 * Initial Contributors:
       
    30 * Nokia Corporation - initial contribution.
       
    31 *
       
    32 * Contributors:
       
    33 *
       
    34 * Description: 
       
    35 *
       
    36 */
       
    37 
       
    38 using System;
       
    39 using System.Collections.Generic;
       
    40 using System.Text;
       
    41 using System.Reflection;
       
    42 using HeapLib.Reconstructor.DataSources.Analyser.Interpreter;
       
    43 
       
    44 namespace HeapLib.Reconstructor.DataSources.Analyser.Extractor
       
    45 {
       
    46     // <summary>
       
    47     // The job of the extractor is just to remove any prefix associated
       
    48     // with a given line. For example, the text-based file formats contain
       
    49     // prefixes which allow multiple heap dumps to appear within one 
       
    50     // trace file. We must partition these heap dumps into individual data
       
    51     // sources, hence we must be able to identify those prefixes and use
       
    52     // them during the partitioning operation.
       
    53     // 
       
    54     // This is the sole purpose for this class.
       
    55     // </summary>
       
    56     internal abstract class Extractor
       
    57     {
       
    58         #region Constructors & destrutor
       
    59         protected Extractor()
       
    60         {
       
    61         }
       
    62         #endregion
       
    63 
       
    64         #region API
       
    65         public abstract bool CanExtractFrom( string aLine );
       
    66 
       
    67         public abstract bool ExtractFrom( string aLine, bool aForceExtractionOfThreadIdentifier );
       
    68         #endregion
       
    69 
       
    70         #region Properties
       
    71         public abstract string Hash { get; }
       
    72 
       
    73         public string PrimaryLine
       
    74         {
       
    75             get { return iPrimaryLine; }
       
    76             protected set { iPrimaryLine = value; }
       
    77         }
       
    78 
       
    79         public InterpreterBase Interpreter
       
    80         {
       
    81             get { return iInterpreter; }
       
    82             set { iInterpreter = value; }
       
    83         }
       
    84         #endregion
       
    85 
       
    86         #region Internal methods
       
    87         #endregion
       
    88 
       
    89         #region Data members
       
    90         private string iPrimaryLine = string.Empty;
       
    91         private InterpreterBase iInterpreter = null;
       
    92         #endregion
       
    93     }
       
    94 }