IProject abstract#

Core project management interface for PIComposer applications.

This interface represents a container for all models and documents within a project. It is typically implemented by a key-value database store that supports comprehensive backup and restore functionality, model management, and project metadata operations.

Projects serve as the organizational unit for related models and provide:

• Centralized model storage and retrieval
• Backup and restore capabilities
• Model categorization and filtering
• Project-level metadata management
• Cross-model operations and references

Constructors#

IProject()#

Properties#

hashCode no setter inherited#

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from Object.

external int get hashCode;

runtimeType no setter inherited#

A representation of the runtime type of the object.

Inherited from Object.

external Type get runtimeType;

Methods#

createBackup()#

Creates a backup of the entire project.

Parameters:

• description: Descriptive information about the backup

Returns a BackupInfo object containing details about the created backup.

BackupInfo createBackup(String description);

createModel()#

Creates a new model within this project.

Parameters:

• header: The model header containing initial configuration
• modelId: Optional custom model identifier (uses GUID if not provided)
• tag: Optional tag for categorizing the model

Returns the newly created IModel instance.

FutureOr<IModel> createModel(PIModelHeader header,
    {String? modelId, String? tag});

deleteBackup()#

Deletes a specific backup by its identifier.

Parameters:

• backupId: The identifier of the backup to delete

Returns true if the backup was successfully deleted, false otherwise.

bool deleteBackup(int backupId);

deleteModel()#

Deletes a model from the project by its identifier.

Parameters:

• modelId: The unique identifier of the model to delete

Returns true if the model was successfully deleted, false otherwise.

bool deleteModel(String modelId);

getBackupInfo()#

Gets information about a specific backup by its identifier.

Parameters:

• backupId: The identifier of the backup to retrieve information for

Returns a BackupInfo object for the specified backup.

BackupInfo getBackupInfo(int backupId);

getBackupInfos()#

Gets information about all backups available for this project.

Returns a list of BackupInfo objects for all existing backups.

List<BackupInfo> getBackupInfos();

getId()#

Gets the unique identifier of this project.

String getId();

getInfo()#

Retrieves ProjectInfo information about this project.

ProjectInfo getInfo();

getLocation()#

Gets the filesystem location/path of the project database.

String getLocation();

getModel()#

Retrieves a model by its unique identifier.

Parameters:

• modelId: The unique identifier of the model to retrieve

Returns the requested IModel instance, or null if not found.

IModel? getModel(String modelId);

getModelInfo()#

Gets information for a specific model by its identifier.

Parameters:

• modelId: The unique identifier of the model

Returns the ModelInfo for the requested model.

ModelInfo getModelInfo(String modelId);

getModelsBySchema()#

Gets all models that use the specified schema.

Parameters:

• schemaEn: The schema enumeration to filter models by

Returns a list of ModelInfo objects for matching models.

List<ModelInfo> getModelsBySchema(SupportedSchema schemaEn);

getModelsByTag()#

Gets all models that have been tagged with the specified tag.

Parameters:

• tag: The tag to filter models by

Returns a list of ModelInfo objects for matching models.

List<ModelInfo> getModelsByTag(String tag);

getModelSchemas()#

Gets a list of all schema types used by models in this project.

Returns a list of SupportedSchema enumeration values representing the distinct schema types present in the project's models.

List<SupportedSchema> getModelSchemas();

getName()#

Gets the human-readable name of this project.

String getName();

importModel()#

Imports a model from an external file into this project.

Parameters:

• filePath: The path to the model file to import
• modelId: The identifier to assign to the imported model
• asReference: Whether to import as a reference model (read-only) Note: Only Part 21 models can be imported as reference models

Returns the imported IModel instance.

FutureOr<IModel> importModel(String filePath,
    [String modelId = '', bool asReference = false]);

initialize()#

Initializes the project with the specified parameters.

Prepares the project for operations, including database connections, resource allocation, and initial setup.

FutureOr<bool> initialize(dynamic parameter);

modelCount()#

Gets the total number of models contained in this project.

int modelCount();

modelInfos()#

Gets information for all models in this project.

Returns a list of ModelInfo objects containing metadata for each model.

List<ModelInfo> modelInfos();

noSuchMethod() inherited#

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

purgeOldBackups()#

Deletes old backups, keeping only the specified number of most recent ones.

Parameters:

• backupToKeepCount: The number of most recent backups to retain

Returns true if the purge operation was successful, false otherwise.

bool purgeOldBackups(int backupToKeepCount);

toString() inherited#

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Object.

external String toString();

uninitialize()#

Shuts down the project, releasing all resources.

Performs cleanup operations, closes database connections, and ensures all pending changes are persisted.

FutureOr<bool> uninitialize();

Operators#

operator ==() inherited#

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

• Total: It must return a boolean for all arguments. It should never throw.

• Reflexive: For all objects o, o == o must be true.

• Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

• Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Object.

external bool operator ==(Object other);