tracesrv/tracecompiler/src/com.nokia.tracecompiler/src/com/nokia/tracecompiler/model/TraceModelPersistentExtension.java
author hgs
Fri, 08 Oct 2010 14:56:39 +0300
changeset 56 aa2539c91954
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
56
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2007 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
* Interface implemented by trace model extensions that need to store themselves 
hgs
parents:
diff changeset
    17
* into persistent storage along with other model elements
hgs
parents:
diff changeset
    18
*
hgs
parents:
diff changeset
    19
*/
hgs
parents:
diff changeset
    20
package com.nokia.tracecompiler.model;
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
/**
hgs
parents:
diff changeset
    23
 * Interface implemented by trace model extensions that need to store themselves
hgs
parents:
diff changeset
    24
 * into persistent storage along with other model elements. The storage format
hgs
parents:
diff changeset
    25
 * is left to the implementation. When loading, the trace provider calls
hgs
parents:
diff changeset
    26
 * TraceObjectFactory.createExtension with the storage name. The object factory
hgs
parents:
diff changeset
    27
 * returns an instance of this interface and the provider calls setData to
hgs
parents:
diff changeset
    28
 * initialize this.
hgs
parents:
diff changeset
    29
 * 
hgs
parents:
diff changeset
    30
 */
hgs
parents:
diff changeset
    31
public interface TraceModelPersistentExtension extends TraceModelExtension {
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
	/**
hgs
parents:
diff changeset
    34
	 * Gets the name used when storing this extension
hgs
parents:
diff changeset
    35
	 * 
hgs
parents:
diff changeset
    36
	 * @return the storage name
hgs
parents:
diff changeset
    37
	 */
hgs
parents:
diff changeset
    38
	public String getStorageName();
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
	/**
hgs
parents:
diff changeset
    41
	 * Gets the data of this extension
hgs
parents:
diff changeset
    42
	 * 
hgs
parents:
diff changeset
    43
	 * @return the extension data
hgs
parents:
diff changeset
    44
	 */
hgs
parents:
diff changeset
    45
	public String getData();
hgs
parents:
diff changeset
    46
hgs
parents:
diff changeset
    47
	/**
hgs
parents:
diff changeset
    48
	 * Sets the data of this extension
hgs
parents:
diff changeset
    49
	 * 
hgs
parents:
diff changeset
    50
	 * @param data
hgs
parents:
diff changeset
    51
	 *            the data
hgs
parents:
diff changeset
    52
	 * @return true if extension should be added to model, false if not
hgs
parents:
diff changeset
    53
	 */
hgs
parents:
diff changeset
    54
	public boolean setData(String data);
hgs
parents:
diff changeset
    55
hgs
parents:
diff changeset
    56
}