Package org.openquark.cal.services

Provides the top-level API for accessing services provided by the Quark Platform.

See:
Description

Interface Summary

AutoCompleteHelper.Document
CALWorkspaceEnvironmentProvider	Warning- this class should only be used by the CAL services implementation.
CALWorkspaceEnvironmentProvider.Factory	Warning- this class should only be used by the CAL services implementation.
CarBuilder.Monitor	This interface specifies a progress monitor to be used with a CarBuilder for monitoring the progress of the Car building operation.
CarStore	A CarStore represents a repository which holds CAL Archives (Cars) as resources.
GemDesignStore	A GemDesignStore represents a repository for gem designs.
GemSorter	A GemSorter applies an ordering to a collection of entities.
ResourceName.Filter	A filter for resource names.
ResourcePathMapper	A path mapper is responsible for generating paths to resources for path-based resource stores.
ResourcePathMapper.Module	A path mapper for module resources.
ResourcePathStore	A ModuleResourceStore which uses ResourcePaths to find resources.
ResourceStore	A ResourceStore represents a repository which holds the resources for a given resource type.
ResourceStore.Module	A ResourceStore.Module represents a repository which holds the module resources for a given resource type.
RevisionHistory	Warning- this class should only be used by the CAL services implementation.
StoredVaultElement	A StoredVaultElement represents a persisted form for a workspace entities in a vault.
StoredVaultElement.Car	A StoredVaultElement.Car represents a presisted form for a CAL Archive (Car).
StoredVaultElement.Module	A StoredVaultElement.Module represents a persisted base form for a module.
StoredVaultElement.WorkspaceDeclaration	A StoredVaultElement.WorkspaceDeclaration represents a persisted form for a workspace declaration.
UserResourceStore	A UserResourceStore represents a repository which holds user resources.
Vault	The Vault is a storage context (a.k.a. repository) for Gems.
Vault.VaultProvider	A VaultProvider is used to retrieve vaults of a given type.
VaultAuthenticator	A VaultAuthenticator provides a callback mechanism whereby the workspace loader can perform vault-specific authentication on demand when retrieving modules from a secured store.
VirtualResourceManager.CarAwareResourceManagerProvider	This interface specifies a provider that is capable of creating a new resource manager of a particular resource type for each Car in the system.
WorkspaceDeclaration.StreamProvider	A simple wrapper around an input stream on a workspace declaration, and a name for that stream.
WorkspaceDeclarationStore	A WorkspaceDeclarationStore represents a repository which holds a number of workspace declarations.
WorkspaceManager.SourceGenerationRootOverrideProvider	This provider interface allows the client to override where the root of the workspace for source generation will be located when constructing the workspace maanger.

Class Summary

AbstractResourcePathStore	This class provides a basic implementation of some of the methods in the ResourcePathStore interfaces.
Assert	A static helper class which contains various utility methods which can be used to check code preconditions at runtime.
AutoCompleteHelper	Helper class for performing auto-completions in editors of cal source code.
BasicCALServices	This is a helper class to assist CAL clients with creating and using some of the basic CAL services.
BasicCALServices.Config	This class is used to encapsulate BasicCALServices configuration properties.
BasicCALWorkspace	Warning- this class should only be used by the CAL services implementation.
BasicCALWorkspace.Discrete	A discrete workspace represents a single folder (plus subfolders) in the file system.
BasicCALWorkspace.Nullary	The "nullary" CAL workspace.
BasicProgramResourcePathRepository	Warning- this class should only be used by the CAL services implementation.
CALFeatureName	A class that can be used to uniquely identify any CAL feature.
CALPersistenceHelper	A static helper class to facilitate conversions between CAL objects and their XML representations.
CALSourceManager	A manager to manage saving and loading CAL source using a source store.
CALSourcePathMapper	A ResourcePathMapper for CAL source file resources.
CALWorkspace	A CALWorkspace represents a set of modules from which a program can be compiled.
CALWorkspace.DependencyFinder	A helper class for finding module dependencies.
CALWorkspace.SyncInfo	Warning- this class should only be used by the CAL services implementation.
Car	A Car represents a CAL Archive file (a Car file) as a workspace resource.
Car.Accessor	The Car.Accessor provides read access to a Car in its role as a container for other resources.
Car.Factory	Instances of Car are meant to be created by an instance of this Factory class.
CarBuilder	This class implements a CAL Archive (Car) builder that will go through the resources in a supplied workspace and add those resources to a new Car.
CarBuilder.BuilderOptions	Encapsulates the options for the Car builder.
CarBuilder.Configuration	This class encapsulates the configuration options for the CarBuilder.
CarBuilder.ConfigurationsForOneCarPerWorkspaceDeclaration	Encapsulates a set of CarBuilder.Configurations that are constructed for building one Car per workspace declaration.
CarBuilder.DefaultMonitor	This is a default implementation of the Monitor interface which does nothing, and which always returns true for isCanceled().
CarBuilder.FileOutputConfiguration	Encapsulates the configuration for building a Car and saving it to the file system, including in particular the CarBuilder.Configuration for the Car.
CarFeatureName	A CarFeatureName instance encapsulates the name of a CAL Archive (Car) as a FeatureName (which is used to identify the Car as part of a ResourceIdentifier).
CarManager	A manager to manage loading CAL Archives (Cars) using a Car store.
CarPathMapper	A ResourcePathMapper for CAL Archives (Cars) as resources.
CarTool	This class provides a command line interface to the CAL Archive (Car) building tool.
CarVault	A CarVault is a read-only vault backed by a CAL Archive (Car) containing the resources for one or more modules.
DefaultWorkspaceDeclarationProvider	A Workspace declaration provider which chooses the source of its declaration based on provided system properties and defaults.
FeatureName	A class that can be used to uniquely identify a feature.
FeatureName.FeatureType	A class for the feature type enum pattern that identifies the type of a CAL feature.
FileModuleSourceDefinition	A ModuleSourceDefinition that provides source from a file.
FilePathModuleSourceDefinition	A ModuleSourceDefinition that provides source from a file path.
FileSystemResourceHelper	A static helper class which contains various utility methods used in the manipulation of module resources with respect to the file system.
GemComparatorSorter	This class is an implementation of the GemSorter interface that makes it easy to define custom sorter implementations by providing an entity comparator.
GemDesign	A GemDesign represents a client design for a GemEntity.
GemDesignManager	This class implements the manager responsible for saving and loading GemDesign objects to a GemDesignStore using XML files.
GemDesignPathMapper	A ResourcePathMapper for GemDesign resources.
GemEntity	A GemEntity encapsulates information for an envEntity, including its source, design, and metadata.
GemFilter	A GemFilter filters a collection of entities.
GemFormSorter	This sorter sorts GemEntities based on their form (ie. whether they are a supercombinator, class method, data constructor, ...)
GemQualifiedNameCaseInsensitiveSorter	This sorter sorts GemEntities based on their qualified name.
GemUnqualifiedNameCaseInsensitiveSorter	This sorter sorts GemEntities based on their unqualified name.
GemViewer	A GemViewer is a viewer on a collection of GemEntities.
IdentifierUtils	Provides helper methods for creating valid CAL identifiers, and for describing the problems in proposed CAL identifiers.
IdentifierUtils.ValidatedIdentifier	Class used for holding result of validation operations.
IdentifierUtils.ValidationStatus	Class enumerating status of an identifier validation.
JarFileManager	This class implements a manager for a JarFile.
JarVault	A JarVault is a read-only vault backing a jar containing the resources for a single module.
LocaleUtilities	Encapsulates helper methods for working with Locale values.
LocalizedResourceName	A LocalizedResourceName identifies a localized resource, not taking into account the resource's type.
MetaModule	A metamodule encapsulates a module and all related metadata, including source (if any).
ModulePackager	This class provides utility methods to aid in persistence and navigation of module resources in .packaged form.
ModuleResourceManager	A resource manager for module-related resources.
ModuleResourceStoreHelper	Warning- this class should only be used by the CAL services implementation.
ModuleRevision	Warning- this class should only be used by the CAL services implementation.
NullaryEnvironment	A nullary environment encapsulates the details of finding resources relative to the current classpath.
Perspective	A perspective defines a working context within a workspace.
ProgramModelManager	This class presents a higher-level abstraction to the program manager.
ProgramModelManager.CompilationOptions	A class to encapsulate the various compilation options when compiling a module or adjunct.
ProgramResourceManager	The resource manager for cal program resources in the workspace.
ProgramResourceManager.CarBased	Implements a Car-based ProgramResourceManager, where all the (read-only) resources come from a Car.
ProgramResourceManager.FileSystemBased	Implements a file-system-based ProgramResourceManager, where all the resources come from the file system.
ProgramResourcePathMapper	A path mapper for program resources.
ResourceFileStore	Warning- this class should only be used by the CAL services implementation.
ResourceFileStore.Module	A ResourceFileStore for module resources.
ResourceIdentifier	A ResourceIdentifier identifies a resource.
ResourceJarStore	Warning- this class should only be used by the CAL services implementation.
ResourceJarStore.Module	A ResourceJarStore for module resources.
ResourceManager	A manager which handles saving and loading a resource with respect to a resource store.
ResourceManagerRegistry	A ResourceManagerRegistry manages the WorkspaceResourceManagers for the workspace.
ResourceName	A ResourceName identifies a resource, not taking into account the resource's type.
ResourceNullaryStore	Warning- this class should only be used by the CAL services implementation.
ResourceNullaryStore.Module	A ResourceNullaryStore for module resources.
ResourcePath	A ResourcePath represents a componentized path relative to the classloader root.
ResourcePath.FilePath	A ResourcePath which represents a resource/file.
ResourcePath.Folder	A ResourcePath which represents a Folder.
ResourceRevision	Warning- this class should only be used by the CAL services implementation.
ResourceRevision.Info	The revision info for a group of resources.
SimpleCALFileVault	A Vault which wraps a module specified by a simple .cal file.
SimpleCarFileVault	A Vault which wraps a CAL Archive (Car) file specified by a URL.
SingleApplicationTypeFilter	A filter that filters on the gem's type expression.
StandaloneJarTool	This class implements a command-line utility for constructing a standalone JAR, which may contain application and library classes.
StandardVault	The default gem repository.
Status	A class representing the status of an action.
Status.Severity	Severity enum pattern.
StoreBasedVault	A StoreBasedVault stores and retrieves module resources using resource stores for each type of resource.
StringModuleSourceDefinition	A ModuleSourceDefinition that provides source from a string.
UnorderedTypeMatchFilter	A filter that matches against a subset of the gem's input types, and optionally against a range of output types.
UserResourceFeatureName	A UserResourceFeatureName instance encapsulates the name of a user resource.
UserResourceManager	A resource manager for managing the loading of user resources from a resource store.
UserResourcePathMapper	A path mapper for user resources.
VaultAuthenticationManager	A VaultAuthenticationManager manages the mappings from vault type to the VaultAuthenticator registered for those types.
VaultElementInfo	A simple container class for the vault-related info about a stored vault element.
VaultElementInfo.Basic	A VaultElementInfo.Basic instance represents the vault-related info of an element stored in a "top-level" vault, e.g. the standard vault or the enterprise vault.
VaultElementInfo.Nested	A VaultElementInfo.Nested instance represents the vault-related info of an element stored in a "nested" vault, e.g. a Car vault.
VaultRegistry	A VaultRegistry maintains a registry of known VaultProviders, thus providing a way to instantiate a vault given its descriptor and location string.
VaultStatus	An object to encapsulate the current vault-related status of modules in the workspace.
VaultWorkspaceDeclarationProvider	A Workspace declaration provider which chooses the source of its declaration based on provided system properties and defaults.
VirtualResourceManager	This class encapsulates the notion that there can be multiple resource managers for each kind of module resource, and that there is a mapping from module name to the set of resource managers for it.
VirtualResourceManager.ModuleNameToResourceManagerMapping	This class encapsulates a module name to resource manager mapping.
WorkspaceConfiguration	This class holds configuration information for the workspace.
WorkspaceDeclaration	A simple class which contains the abstract representation of a workspace declaration.
WorkspaceDeclarationFeatureName	A FeatureName to identify a WorkspaceDeclaration.
WorkspaceDeclarationManager	A manager to manage saving and loading workspace declarations using a workspace declaration store.
WorkspaceDeclarationPathMapper	A ResourcePathMapper for WorkspaceDeclaration resources.
WorkspaceLoader	A class responsible for loading a program that comprises an initial workspace.
WorkspaceManager	A manager for CAL source and compiled forms of modules.
WorkspaceResource	A persistent object which exists within a workspace, is locatable, and contains attributes and content.
WorkspaceResource.SyncTime	Warning- this class should only be used by the CAL services implementation.

Exception Summary

CALWorkspaceEnvironmentProvider.FactoryException	Warning- this class should only be used by the CAL services implementation.
GemCompilationException	An exception used to indicate that a compilation error occurred when compiling the CAL code resulting from a gem graph.

Package org.openquark.cal.services Description

Provides the top-level API for accessing services provided by the Quark Platform.

Key classes in this package

BasicCALServices

This helper class provides assistance with common workflows for using CAL services. It handles the initialization and loading of a workspace, and provides methods for evaluating CAL code and filtering gems.

WorkspaceManager and CALWorkspace

A CALWorkspace encapsulates a workspace and the persistent resources associated with it, while a WorkspaceManager is responsible for managing both a CALWorkspace and the CAL runtime environment.

These two classes represent the main entry points for accessing many of the services provided by the Quark platform.

CarTool

This class provides a command line interface to the CAL Archive (Car) building tool.

Author:

Joseph Wong, Edward Lam