File-system-based entity

To manage data structures and resources in the file system, the concept of an entity is used. An entity is a folder, annotated with metadata and included resources. An entity folder has the following structure:
  • Entity folder
    • .entity
      • entity.xml
      • Included resource files
    • Entity data

Hint: On a Windows operating system, the folder .entity should have the hidden attribute. On UNIX-like operating systems, the prefixed period tells the operating system that the folder is hidden.

An entity usally has a specific type, which defines the semantics of the entity. One entity type is project which is the main entity type implemented by baobab.

Metadata folder .entity

The hidden .entity folder is the place to store metadata about the entity and additional resources required by the entity. It can contain sub folders for certain kinds of resources.

Metadata file entity.xml

The metadata file entity.xml contains at least a GUID, identifying the entity, the entity type, and a name for the entity. Further it contain some specific metadata for the entity type.

Last edited May 3, 2013 at 10:22 AM by cytrek83, version 5


No comments yet.