Package org.faktorips.runtime

Interface IRuntimeRepository

All Known Subinterfaces:
IDetachedContentRuntimeRepository, IModifiableRuntimeRepository
All Known Implementing Classes:
AbstractCachingRuntimeRepository, AbstractClassLoadingRuntimeRepository, AbstractRuntimeRepository, AbstractTocBasedRuntimeRepository, AbstractXmlInputStreamRepository, ClassloaderRuntimeRepository, DetachedContentRuntimeRepository, InMemoryRuntimeRepository
public interface IRuntimeRepository
The runtime repository gives access to the information about products, enums and tables.
Author:
Jan Ortmann

  • Method Details

    • getName

      String getName()
      Returns the repository's name.

    • addDirectlyReferencedRepository

      void addDirectlyReferencedRepository(IRuntimeRepository repository)
      Adds a repository this repository depends on because the one to add contains product data that is referenced from this repository. Access methods like getProductComponent(..) include all repositories this one depends on in their search.
      Parameters:
      repository - The repository to add.
      Throws:
      NullPointerException - if repository is null.

    • getDirectlyReferencedRepositories

      List<IRuntimeRepository> getDirectlyReferencedRepositories()
      Returns the runtime repositories this one directly depends on.

    • getAllReferencedRepositories

      List<IRuntimeRepository> getAllReferencedRepositories()
      Returns all repositories this one depends on directly or indirectly. The order is defined by a breadth first search starting with this repository's direct dependencies. Each repository is only included once even if it is referenced from two others. The list is computed lazy on the first request.

    • getProductComponent

      IProductComponent getProductComponent(String id)
      Returns the product component identified by the given id. Returns null if the id is null or no component with the indicated id can be found.

      Note

      How the product component id is structured, is defined as part of the ips project. The definition is called a product component naming (and identification) strategy. The standard strategy is to use the id of the product component kind followed by a separator followed by component's versionId. However it is possible to use completly different strategies for example to create numeric identifiers to reduce the size of indices in a datatbase. In the latter case the product component id can't be derived from the product component kind id and it's version id.

      Parameters:
      id - The id of the product component to find.
      Returns:
      The product component identified by the id or null.

    • getExistingProductComponent

      IProductComponent getExistingProductComponent(String id)
      Returns the product component identified by the given id. Same as getProductComponent(String id) but throws an exception if the product component is not found. This method never returns null.
      Parameters:
      id - The id of the product component to find.
      Returns:
      The product component identified by the id
      Throws:
      ProductCmptNotFoundException - if no product component with the given id exists.
      See Also:

    • getProductComponent

      IProductComponent getProductComponent(String kindId, String versionId)
      Returns the product component identified by the given KindId and versionId. If versionId is null the most recent version is returned. Returns null if the kindId is null or no component with the indicated kindId and versionId can be found.
      Parameters:
      kindId - The product component kind id, e.g. CollisionCoverage
      versionId - The versionId to find, e.g. 2005-01
      Returns:
      The product component identified by the id or null.

    • getAllProductComponents

      List<IProductComponent> getAllProductComponents(String kindId)
      Returns all product components that belong to the indicated product component kind. Returns an empty array if either kindId is null or no component with the indicated kind is found.
      Parameters:
      kindId - The product component kind id, e.g. CollisionCoverage

    • getEnumValues

      <T> List<T> getEnumValues(Class<T> clazz)
      Returns the type safe List of enumeration values of the provided Faktor-IPS generated enumeration class. This method is only relevant for Faktor-IPS enumerations whose values are deferred to a content that is held by this repository.
      Parameters:
      clazz - the enumeration class upon which the list of enumeration values is returned
      Returns:
      The UNMODIFIABLE list of enum values.

    • getEnumValue

      <T> T getEnumValue(Class<T> clazz, Object id)
      Returns the enumeration value for the provided enumeration class with the given id. If no value is found in the enumeration of the provided enumeration class null will be returned. If the provided class cannot be recognized as a Faktor-IPS enumeration or id is null, null will be returned. This method is only relevant for Faktor-IPS enumerations whose values are deferred to a content that is held by this repository.
      Parameters:
      clazz - The enumeration class upon which the enumeration value is returned
      id - The enum value's identification
      Returns:
      the enumeration value, or null if it does not exist
      See Also:

    • getExistingEnumValue

      <T> T getExistingEnumValue(Class<T> clazz, Object id)
      Returns the enumeration value for the provided enumeration class with the given id. This method is only relevant for Faktor-IPS enumerations whose values are deferred to a content that is held by this repository. If id is null, null will be returned. Unlike getEnumValue(Class, Object), this method will throw an exception when no enum value matching the parameters is found in the repository.
      Parameters:
      clazz - The enumeration class upon which the enumeration value is returned
      id - The enum value's identification
      Returns:
      the enumeration value
      Throws:
      IllegalArgumentException - if the given id has no corresponding enum value
      See Also:

    • getEnumValue

      @Deprecated Object getEnumValue(String uniqueId)
      Deprecated.
      This method does only return valid enums if the id attribute of the enum is of type String. You should never use this method! Use getEnumValue(Class, Object) instead. This method may be removed in future releases.
      Returns the enumeration value for the provided unique Id. The unique Id is specified as follows qualifiedClassName'#'valueId.

    • addEnumValueLookupService

      void addEnumValueLookupService(IEnumValueLookupService<?> lookupService)
      Adds the service to lookup enumeration values for the enumeration type specified by IEnumValueLookupService.getEnumTypeClass(). If a service is already registered for the enumeration type, the new service replaces the old one.
      Parameters:
      lookupService - The new lookup service.

    • getEnumValueLookupService

      <T> IEnumValueLookupService<T> getEnumValueLookupService(Class<T> enumClazz)
      Returns the lookup service for the given enumeration type. Returns null if no service is registered for the given type.

    • removeEnumValueLookupService

      void removeEnumValueLookupService(IEnumValueLookupService<?> lookupService)
      Removes the lookup service registered for the given enumeration type. Does nothing if no such service has been registered.

    • getAllEnumClasses

      List<Class<?>> getAllEnumClasses()
      Returns all classes for that define enumerations in this repository. All enums types (with and without separated content) defined by Faktor-IPS are returned for the model project they are defined in. For projects containing enum contents, only the matching structure classes are returned from the product project. Model projects must be referenced with addDirectlyReferencedRepository(IRuntimeRepository) for their enum structures without content to be found.

      Returns an empty list if no enum class is available.

    • getEnumDescription

      default <T> org.faktorips.values.InternationalString getEnumDescription(Class<T> enumClazz)
      Returns the description for the given enumeration type.
      Type Parameters:
      T - The enum type
      Parameters:
      enumClazz - the enum type's class
      Since:
      24.1

    • getProductComponentGeneration

      IProductComponentGeneration getProductComponentGeneration(String id, Calendar effectiveDate)
      Returns the product component generation identified by the id and the effective date. Returns null if either the id is null, the effectiveDate is nullor no generation with the indicated id can be found or the product component hasn't got a generation that is effective on the given date.
      Parameters:
      id - The product component's id.
      effectiveDate - The process' effective date
      Returns:
      The product component generation or null.

    • getExistingProductComponentGeneration

      IProductComponentGeneration getExistingProductComponentGeneration(String id, Calendar effectiveDate)
      Returns the product component generation identified by the id and the effective date. Same as getProductComponentGeneration(String id, Calendar effectiveDate) but throws an exception if the product component generation is not found. This method never returns null.
      Parameters:
      id - The product component's id.
      effectiveDate - The process' effective date
      Returns:
      The product component generation
      Throws:
      ProductCmptGenerationNotFoundException - if no generation for the given effectiveDate.
      See Also:

    • getAllProductComponents

      <T extends IProductComponent> List<T> getAllProductComponents(Class<T> productComponentType)
      Returns all product components that are instances of the indicated class. Returns an empty list if no such component exists.

    • getAllProductComponents

      List<IProductComponent> getAllProductComponents()
      Returns all product components available in this repository. Returns an empty list if no component is available.

      Note that this is an expensive operation as all components have to be loaded into memory.

    • getProductComponentGenerations

      List<IProductComponentGeneration> getProductComponentGenerations(IProductComponent productCmpt)
      Returns all product component generations for the given product component. Returns an empty list if no generation is available.

      The generations are ordered by valid from date in reverse order that means the latest generation (latest valid from date) is the first one, the oldest generation is the last one.

      Returns:
      The list of product component generations ordered by the valid from date in reverse order

    • getNumberOfProductComponentGenerations

      int getNumberOfProductComponentGenerations(IProductComponent productCmpt)
      Returns the number of product component generations of the provided product component.

    • getNextProductComponentGeneration

      IProductComponentGeneration getNextProductComponentGeneration(IProductComponentGeneration generation)
      Returns the product component generation that follows the provided generation with respect to its valid from date.

      If there is no further generation this method returns null.

      Returns:
      The next generation with respect to the valid from date.
      Throws:
      IllegalArgumentException - if the given product component generation could not be found in this repository or in any dependent repository.

    • getPreviousProductComponentGeneration

      IProductComponentGeneration getPreviousProductComponentGeneration(IProductComponentGeneration generation)
      Returns the product component generation that is prior to the provided generation with respect to its valid from date.

      If there is no previous generation this method returns null.

      Returns:
      The previous generation with respect to the valid from date.
      Throws:
      IllegalArgumentException - if the given product component generation could not be found in this repository or in any dependent repository.

    • getLatestProductComponentGeneration

      IProductComponentGeneration getLatestProductComponentGeneration(IProductComponent productCmpt)
      Returns the latest product component generation of the provided product component.
      Returns:
      The generation with the latest valid from date

    • getAllProductComponentIds

      List<String> getAllProductComponentIds()
      Returns a list of the IDs of all product components held by this repository or any dependent repository.
      Returns:
      All valid product component IDs that are accessible by this repository.

    • getAllTables

      List<ITable<?>> getAllTables()
      Returns all tables available in this repository. Returns an empty list if no table is available.

      Note that this is an expensive operation as all tables have to be loaded into memory.

      See Also:

    • getAllTableIds

      List<String> getAllTableIds()
      Returns the IDs of all tables available in this repository. Returns an empty list if no table is available.
      Since:
      24.1
      See Also:

    • getTable

      <T extends ITable<?>> T getTable(Class<T> tableClass)
      Returns the table contents for the given single content table class.
      Throws:
      IllegalArgumentException - if table is multi content.
      See Also:

    • getTable

      ITable<?> getTable(String qualifiedTableName)
      Returns the table contents for the given qualified table name. Works for both single/multi-content tables.

    • getAllIpsTestCases

      List<IpsTest2> getAllIpsTestCases(IRuntimeRepository runtimeRepository)
      Returns a list of all test cases stored in the repository and all repositories this one references. Returns an empty list if none is found.

    • getIpsTestCasesStartingWith

      List<IpsTest2> getIpsTestCasesStartingWith(String qNamePrefix, IRuntimeRepository runtimeRepository)
      Returns a list of test cases starting with the given qualified name prefix stored in the repository and all repositories this one references. Returns an empty list if none is found.

    • getIpsTest

      IpsTest2 getIpsTest(String qName)
      Returns the test (either test case or suite) for the given qualified name. If a test is found for the given qualified name, the test is returned. Otherwise a test suite containing all tests that starts with the given qualified name is returned. Returns an empty test suite if no tests are found for the given qualified name.
      Throws:
      NullPointerException - if qName is null.

    • getIpsTest

      IpsTest2 getIpsTest(String qName, IRuntimeRepository runtimeRepository)
      Returns the test (either test case or suite) for the given qualified name. If a test is found for the given qualified name, the test is returned. Otherwise a test suite containing all tests that starts with the given qualified name is returned. Returns an empty test suite if no tests are found for the given qualified name. The given runtime repository is the repository which will be used to instantiate the test cases.
      Throws:
      NullPointerException - if qName is null.
      See Also:

    • getIpsTestCase

      IpsTestCaseBase getIpsTestCase(String qName)
      Returns the test case for the given qualified name.
      Throws:
      NullPointerException - if qName is null.

    • getIpsTestCase

      IpsTestCaseBase getIpsTestCase(String qName, IRuntimeRepository runtimeRepository)
      Returns the test case for the given qualified name. The given runtimeRepository will be used to instantiate the test case (this repository is used to search for test cases).
      Remark this runtime repository which will be used to search for the given test case can differ from the runtime repository which will be used to instantiate the test case during runtime.
      Normally the runtime repository contains all repositories which are referenced by the project.
      Throws:
      NullPointerException - if qName is null.

    • getIpsTestSuite

      IpsTestSuite getIpsTestSuite(String qNamePrefix)
      Returns a test suite that contains all tests that have qualified names starting with the given prefix. Note that if test cases belong to different package fragments the returned test suite contains other testsuites. One suite for each package fragment.
      Throws:
      NullPointerException - if qNamePrefix is null.

    • getIpsTestSuite

      IpsTestSuite getIpsTestSuite(String qNamePrefix, IRuntimeRepository runtimeRepository)
      Returns a test suite that contains all tests that have qualified names starting with the given prefix. Note that if test cases belong to different package fragments the returned test suite contains other test suites. One suite for each package fragment. The given runtime repository is the repository which will be used to instantiate the test cases.
      Throws:
      NullPointerException - if qNamePrefix is null.
      See Also:

    • isModifiable

      boolean isModifiable()
      Returns true if the repository's content is modifiable. This feature is mainly targeted for writing test cases that need to setup a repository with a test specific content programmatically. Returns false otherwise.

    • getModelType

      @Deprecated Type getModelType(Class<?> modelObjectClass)
      Deprecated.
      Use IpsModel.getType(Class)
      Returns the IModelType containing the meta information for the given model object class.

    • getModelType

      @Deprecated PolicyCmptType getModelType(IModelObject modelObject)
      Deprecated.
      Use IpsModel.getPolicyCmptType(IModelObject)
      Returns the IModelType containing the meta information for the given model object. This is a convenience method calling getModelType with the model object's class.

    • getModelType

      @Deprecated ProductCmptType getModelType(IProductComponent productComponent)
      Deprecated.
      Use IpsModel.getProductCmptType(IProductComponent)
      Returns the IModelType containing the meta information for the given product component. This is a convenience method calling getModelType with the product component class.

    • getAllModelTypeImplementationClasses

      Set<String> getAllModelTypeImplementationClasses()
      Returns a set containing the Java Class names of the implementation classes for all model types available in this repository (either directly or via a referenced repository). For product component types the implementation class for the part that remains unchanged over time is returned. Currently there is no way to get get the implementation class for the product component generation (the part that changed over time).

      Returns an empty set if no type is available.

    • newJAXBContext

      @Deprecated <JAXBContext> JAXBContext newJAXBContext()
      Deprecated.
      for removal since 23.6; directly use an implementation of IXmlBindingSupport.newJAXBContext(IRuntimeRepository) instead
      Creates a new JAXBContext that can marshal / unmarshal all model classes defined in the given repository. If the repository references other repositories (directly or indirectly), the context can also handle the classes defined in these other repositories.

    • getFormulaEvaluatorFactory

      IFormulaEvaluatorFactory getFormulaEvaluatorFactory()
      Getting a formula evaluator factory to create a new formula evaluator. If formula evaluation is not supported, this method should return null.
      Returns:
      The configured formula evaluator or null if no evaluation is supported

    • getClassLoader

      ClassLoader getClassLoader()
      Returns the class loader that is used to load Java classes by this repository.

    • getCustomRuntimeObject

      <T> T getCustomRuntimeObject(Class<T> type, String qName)
      Returns a object of type T, identified by it's qualified name, or null if no such object exists in this repository or it's referenced repositories. It is up to extensions to define which types can be found in the repository (e.g. a AbstractTocBasedRuntimeRepository could define CustomTocEntryObjects for new types. If there are no objects of the given type, null is returned. If the IRuntimeRepository implementation does not allow custom types, null is returned.
      Parameters:
      type - a class supported by the IRuntimeRepository implementation
      qName - the qualified name of the object
      Returns:
      the object identified by qName or null

    • getRuntimeRepositoryLookup

      IRuntimeRepositoryLookup getRuntimeRepositoryLookup()
      Returns the IRuntimeRepositoryLookup that was previously set using setRuntimeRepositoryLookup(IRuntimeRepositoryLookup). The IRuntimeRepositoryLookup is used for serialization of policy components especially for the ProductConfiguration in configured policy components.
      Returns:
      A previously set IRuntimeRepositoryLookup that is serialized by a ProductConfiguration and used to load the product component and its generation after deserialization.
      See Also:

    • setRuntimeRepositoryLookup

      void setRuntimeRepositoryLookup(IRuntimeRepositoryLookup repositoryLookup)
      Setting a IRuntimeRepositoryLookup is needed to enable serialization of policy components. You need to set a IRuntimeRepositoryLookup before you could serialize any product configured policy component.
      Parameters:
      repositoryLookup - The IRuntimeRepositoryLookup will provide an instance of this IRuntimeRepository when deserializing a policy component.
      See Also: