Jump to: navigation, search

Difference between revisions of "FAQ How do I store extra properties on a resource?"

Line 1: Line 1:
 
Several mechanisms are available for attaching metadata to resources.  The simplest are session and persistent properties, which affix arbitrary objects (for session properties) or strings (for persistent properties) to a resource keyed by a unique identifier.  Session properties are discarded when the platform shuts down, and persistent properties are saved on disk and will be available the next time the platform starts up.  Markers are intended to work as annotations to a particular location in a file but in reality can be used to attach arbitrary strings, integers, or Boolean values to a resource. Synchronization information can also be attached to a resource (see <tt>ISynchronizer</tt>). Sync info was designed for clients, such as repositories or deployment tools, that need to track differences between local resources and a remote copy.  Such clients have some very special features, including the ability to maintain the metadata regardless of whether the resource exists.  Although quite specialized, this form of metadata may be appropriate for use in your plug-in. Finally, there is the Eclipse preference API, which has a special node for storing project-specific metadata (see <tt>ProjectScope</tt>). A unique attribute of preferences is that they are stored inside the project location, so that the data is shared when the project is exported or checked into a repository.
 
Several mechanisms are available for attaching metadata to resources.  The simplest are session and persistent properties, which affix arbitrary objects (for session properties) or strings (for persistent properties) to a resource keyed by a unique identifier.  Session properties are discarded when the platform shuts down, and persistent properties are saved on disk and will be available the next time the platform starts up.  Markers are intended to work as annotations to a particular location in a file but in reality can be used to attach arbitrary strings, integers, or Boolean values to a resource. Synchronization information can also be attached to a resource (see <tt>ISynchronizer</tt>). Sync info was designed for clients, such as repositories or deployment tools, that need to track differences between local resources and a remote copy.  Such clients have some very special features, including the ability to maintain the metadata regardless of whether the resource exists.  Although quite specialized, this form of metadata may be appropriate for use in your plug-in. Finally, there is the Eclipse preference API, which has a special node for storing project-specific metadata (see <tt>ProjectScope</tt>). A unique attribute of preferences is that they are stored inside the project location, so that the data is shared when the project is exported or checked into a repository.
  
Table 17.1 provides a high-level view of the various forms of metadata, along with some of their key design features.  ''Speed'' refers to the amount of CPU time required for  typical access and storage operations.  ''Footprint'' refers to the memory space required for storing the information during a session.  Persistent properties are not stored in memory at all, except for a  small cache, which makes them good memory citizens but terrible  for performance.  ''Notify'' refers to whether resource change notification includes broadcasting changes to this metadata.  Note that this is not always a good thing: Performing a resource change broadcast has a definite performance cost, which will be incurred whether or not you care about the notification.  Also, metadata that is included in resource change events cannot be changed by a resource change listener. So if you need a resource change listener to store some state information, you&#146;re stuck with either session or persistent properties. ''Persistence'' describes when the information is written to disk.  Full save happens when the platform is being shut down, and snapshot is a quick incremental save that happens every few minutes while the platform is running. ''Data types'' identify the Java data types that can be stored with that metadata facility.
+
Table 17.1 provides a high-level view of the various forms of metadata, along with some of their key design features.  ''Speed'' refers to the amount of CPU time required for  typical access and storage operations.  ''Footprint'' refers to the memory space required for storing the information during a session.  Persistent properties are not stored in memory at all, except for a  small cache, which makes them good memory citizens but terrible  for performance.  ''Notify'' refers to whether resource change notification includes broadcasting changes to this metadata.  Note that this is not always a good thing: Performing a resource change broadcast has a definite performance cost, which will be incurred whether or not you care about the notification.  Also, metadata that is included in resource change events cannot be changed by a resource change listener. So if you need a resource change listener to store some state information, you&#146;re stuck with either session or persistent properties. Note that preferences are not included in resource change events, but rather have their own separate notification mechanism. ''Persistence'' describes when the information is written to disk.  Full save happens when the platform is being shut down, and snapshot is a quick incremental save that happens every few minutes while the platform is running. ''Data types'' identify the Java data types that can be stored with that metadata facility.
  
 
<table BORDER=1 CELLSPACING=2 CELLPADDING=5>
 
<table BORDER=1 CELLSPACING=2 CELLPADDING=5>
Line 55: Line 55:
 
'''Table 17.1'''&nbsp;&nbsp;
 
'''Table 17.1'''&nbsp;&nbsp;
 
Forms of resource metadata
 
Forms of resource metadata
 +
 +
  
 
Keep in mind that the best solution for your particular situation isn&#146;t always as simple as picking one of these four mechanisms.  Sometimes a combination of these systems works better.  For example, session properties can be used as a high- performance cache during an operation, and the information can then be flushed to a persistent format, such as persistent properties, when your plug-in is not in use.  Finally, for large amounts of metadata, it is often better to store the information in a separate file.  You can ask the platform to allocate a metadata area for your plug-in, using <tt>IProject.getWorkingLocation</tt>, or you can store metadata directly in the project&#146;s content area so that it gets shared with the user&#146;s repository.
 
Keep in mind that the best solution for your particular situation isn&#146;t always as simple as picking one of these four mechanisms.  Sometimes a combination of these systems works better.  For example, session properties can be used as a high- performance cache during an operation, and the information can then be flushed to a persistent format, such as persistent properties, when your plug-in is not in use.  Finally, for large amounts of metadata, it is often better to store the information in a separate file.  You can ask the platform to allocate a metadata area for your plug-in, using <tt>IProject.getWorkingLocation</tt>, or you can store metadata directly in the project&#146;s content area so that it gets shared with the user&#146;s repository.

Revision as of 12:10, 31 October 2008

Several mechanisms are available for attaching metadata to resources. The simplest are session and persistent properties, which affix arbitrary objects (for session properties) or strings (for persistent properties) to a resource keyed by a unique identifier. Session properties are discarded when the platform shuts down, and persistent properties are saved on disk and will be available the next time the platform starts up. Markers are intended to work as annotations to a particular location in a file but in reality can be used to attach arbitrary strings, integers, or Boolean values to a resource. Synchronization information can also be attached to a resource (see ISynchronizer). Sync info was designed for clients, such as repositories or deployment tools, that need to track differences between local resources and a remote copy. Such clients have some very special features, including the ability to maintain the metadata regardless of whether the resource exists. Although quite specialized, this form of metadata may be appropriate for use in your plug-in. Finally, there is the Eclipse preference API, which has a special node for storing project-specific metadata (see ProjectScope). A unique attribute of preferences is that they are stored inside the project location, so that the data is shared when the project is exported or checked into a repository.

Table 17.1 provides a high-level view of the various forms of metadata, along with some of their key design features. Speed refers to the amount of CPU time required for typical access and storage operations. Footprint refers to the memory space required for storing the information during a session. Persistent properties are not stored in memory at all, except for a small cache, which makes them good memory citizens but terrible for performance. Notify refers to whether resource change notification includes broadcasting changes to this metadata. Note that this is not always a good thing: Performing a resource change broadcast has a definite performance cost, which will be incurred whether or not you care about the notification. Also, metadata that is included in resource change events cannot be changed by a resource change listener. So if you need a resource change listener to store some state information, you’re stuck with either session or persistent properties. Note that preferences are not included in resource change events, but rather have their own separate notification mechanism. Persistence describes when the information is written to disk. Full save happens when the platform is being shut down, and snapshot is a quick incremental save that happens every few minutes while the platform is running. Data types identify the Java data types that can be stored with that metadata facility.

  Speed Footprint Notify Persistence Types
Markers Good Medium Yes Save; snapshot String, int, boolean
Sync info Good Medium Yes Save; snapshot byte[]
Session Property Fast Medium No None String
Persistent Property Slow None No Immediate String
Project Preferences Slow Yes Yes Immediate String, all primitive types

Table 17.1   Forms of resource metadata


Keep in mind that the best solution for your particular situation isn’t always as simple as picking one of these four mechanisms. Sometimes a combination of these systems works better. For example, session properties can be used as a high- performance cache during an operation, and the information can then be flushed to a persistent format, such as persistent properties, when your plug-in is not in use. Finally, for large amounts of metadata, it is often better to store the information in a separate file. You can ask the platform to allocate a metadata area for your plug-in, using IProject.getWorkingLocation, or you can store metadata directly in the project’s content area so that it gets shared with the user’s repository.

See Also:


This FAQ was originally published in Official Eclipse 3.0 FAQs. Copyright 2004, Pearson Education, Inc. All rights reserved. This text is made available here under the terms of the Eclipse Public License v1.0.