tracesrv/tracecompiler/src/com.nokia.tracecompiler/src/com/nokia/tracecompiler/decodeplugins/dictionary/encoder/TraceGroup.java
author hgs
Fri, 08 Oct 2010 14:56:39 +0300
changeset 56 aa2539c91954
parent 41 tracefw/tracecompiler/src/com.nokia.tracecompiler/src/com/nokia/tracecompiler/decodeplugins/dictionary/encoder/TraceGroup.java@838cdffd57ce
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
41
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
* Writes groups objects
hgs
parents:
diff changeset
    17
*
hgs
parents:
diff changeset
    18
*/
hgs
parents:
diff changeset
    19
package com.nokia.tracecompiler.decodeplugins.dictionary.encoder;
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
/**
hgs
parents:
diff changeset
    22
 * Writes groups objects
hgs
parents:
diff changeset
    23
 * 
hgs
parents:
diff changeset
    24
 */
hgs
parents:
diff changeset
    25
public class TraceGroup {
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
	/**
hgs
parents:
diff changeset
    28
	 * Writes <options>
hgs
parents:
diff changeset
    29
	 */
hgs
parents:
diff changeset
    30
	public static void startOptions() {
hgs
parents:
diff changeset
    31
		Options.startOptions(TagWriter.INDENT_3);
hgs
parents:
diff changeset
    32
	}
hgs
parents:
diff changeset
    33
hgs
parents:
diff changeset
    34
	/**
hgs
parents:
diff changeset
    35
	 * Writes user defined tags <mytagXXX>value</mytagXXX>
hgs
parents:
diff changeset
    36
	 * 
hgs
parents:
diff changeset
    37
	 * @param tag
hgs
parents:
diff changeset
    38
	 *            user defined tag
hgs
parents:
diff changeset
    39
	 * @param value
hgs
parents:
diff changeset
    40
	 *            value of the tag
hgs
parents:
diff changeset
    41
	 */
hgs
parents:
diff changeset
    42
	public static void writeOption(String tag, String value) {
hgs
parents:
diff changeset
    43
		Options.writeOptions(tag, value, TagWriter.INDENT_4);
hgs
parents:
diff changeset
    44
	}
hgs
parents:
diff changeset
    45
hgs
parents:
diff changeset
    46
	/**
hgs
parents:
diff changeset
    47
	 * Writes </options>
hgs
parents:
diff changeset
    48
	 */
hgs
parents:
diff changeset
    49
	public static void endOptions() {
hgs
parents:
diff changeset
    50
		Options.endOptions(TagWriter.INDENT_3);
hgs
parents:
diff changeset
    51
	}
hgs
parents:
diff changeset
    52
hgs
parents:
diff changeset
    53
	/**
hgs
parents:
diff changeset
    54
	 * Starts <trace data-ref=""> structure
hgs
parents:
diff changeset
    55
	 * 
hgs
parents:
diff changeset
    56
	 * @param dataRef
hgs
parents:
diff changeset
    57
	 *            reference to actual data stored in <data> structure
hgs
parents:
diff changeset
    58
	 * @param name
hgs
parents:
diff changeset
    59
	 *            name of the trace. Can be null if trace doesn't have name            
hgs
parents:
diff changeset
    60
	 */
hgs
parents:
diff changeset
    61
	public static void startTrace(int dataRef, String name) {
hgs
parents:
diff changeset
    62
		Trace.startTrace(dataRef, name);
hgs
parents:
diff changeset
    63
	}
hgs
parents:
diff changeset
    64
hgs
parents:
diff changeset
    65
	/**
hgs
parents:
diff changeset
    66
	 * Writes </trace>
hgs
parents:
diff changeset
    67
	 */
hgs
parents:
diff changeset
    68
	public static void endTrace() {
hgs
parents:
diff changeset
    69
		Trace.endTrace();
hgs
parents:
diff changeset
    70
	}
hgs
parents:
diff changeset
    71
hgs
parents:
diff changeset
    72
	/**
hgs
parents:
diff changeset
    73
	 * Starts <group id="", name="" prefix="" suffix=""> structure
hgs
parents:
diff changeset
    74
	 * 
hgs
parents:
diff changeset
    75
	 * @param id
hgs
parents:
diff changeset
    76
	 *            unique group identifier within dictionary
hgs
parents:
diff changeset
    77
	 * @param name
hgs
parents:
diff changeset
    78
	 *            group name
hgs
parents:
diff changeset
    79
	 * @param prefix
hgs
parents:
diff changeset
    80
	 *            optional prefix for the group
hgs
parents:
diff changeset
    81
	 * @param suffix
hgs
parents:
diff changeset
    82
	 *            optional suffix for the group
hgs
parents:
diff changeset
    83
	 */
hgs
parents:
diff changeset
    84
	static void startGroup(int id, String name, String prefix, String suffix) {
hgs
parents:
diff changeset
    85
		StringBuffer sb = new StringBuffer();
hgs
parents:
diff changeset
    86
		sb.append(TagWriter.GROUP_START_OPEN);
hgs
parents:
diff changeset
    87
		TagWriter.appendAttribute(sb, TagWriter.ID_ATTR, String.valueOf(id),
hgs
parents:
diff changeset
    88
				false);
hgs
parents:
diff changeset
    89
		TagWriter.appendAttribute(sb, TagWriter.NAME_ATTR, name, true);
hgs
parents:
diff changeset
    90
		if (prefix != null) {
hgs
parents:
diff changeset
    91
			TagWriter.appendAttribute(sb, TagWriter.PREFIX_ATTR, prefix, true);
hgs
parents:
diff changeset
    92
		}
hgs
parents:
diff changeset
    93
		if (suffix != null) {
hgs
parents:
diff changeset
    94
			TagWriter.appendAttribute(sb, TagWriter.SUFFIX_ATTR, suffix, true);
hgs
parents:
diff changeset
    95
		}
hgs
parents:
diff changeset
    96
		sb.append(TagWriter.TAG_CLOSE);
hgs
parents:
diff changeset
    97
		TagWriter.write(sb.toString(), TagWriter.INDENT_2);
hgs
parents:
diff changeset
    98
hgs
parents:
diff changeset
    99
	}
hgs
parents:
diff changeset
   100
hgs
parents:
diff changeset
   101
	/**
hgs
parents:
diff changeset
   102
	 * Writes </group>
hgs
parents:
diff changeset
   103
	 */
hgs
parents:
diff changeset
   104
	static void endGroup() {
hgs
parents:
diff changeset
   105
		TagWriter.write(TagWriter.GROUP_END, TagWriter.INDENT_2);
hgs
parents:
diff changeset
   106
	}
hgs
parents:
diff changeset
   107
}