Package org.faktorips.runtime.internal

Class AbstractRuntimeRepository

    • Constructor Detail

      • AbstractRuntimeRepository

        public AbstractRuntimeRepository​(java.lang.String name)

    • Method Detail

      • getClassLoader

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

        This default implementation returns the class loader with which this repository class has been loaded.

        Specified by:
        getClassLoader in interface IRuntimeRepository

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • addDirectlyReferencedRepository

        public final void addDirectlyReferencedRepository​(IRuntimeRepository repository)
        Description copied from interface: IRuntimeRepository
        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.
        Specified by:
        addDirectlyReferencedRepository in interface IRuntimeRepository
        Parameters:
        repository - The repository to add.

      • getAllReferencedRepositories

        public java.util.List<IRuntimeRepository> getAllReferencedRepositories()
        Description copied from interface: IRuntimeRepository
        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.
        Specified by:
        getAllReferencedRepositories in interface IRuntimeRepository

      • getProductComponent

        public final IProductComponent getProductComponent​(java.lang.String id)
        Description copied from interface: IRuntimeRepository
        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.

        Specified by:
        getProductComponent in interface IRuntimeRepository
        Parameters:
        id - The id of the product component to find.
        Returns:
        The product component identified by the id or null.

      • getProductComponentInternal

        protected abstract IProductComponent getProductComponentInternal​(java.lang.String id)
        Same as getProductComponent(String id) but searches only in this repository and not the ones this repository depends on.

      • getProductComponent

        public final IProductComponent getProductComponent​(java.lang.String kindId,
                                                   java.lang.String versionId)
        Description copied from interface: IRuntimeRepository
        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.
        Specified by:
        getProductComponent in interface IRuntimeRepository
        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.

      • getProductComponentInternal

        protected abstract IProductComponent getProductComponentInternal​(java.lang.String kindId,
                                                                 java.lang.String versionId)
        Same as getProductComponent(String kindId, String versionId) but searches only in this repository and not the ones this repository depends on.

      • getAllProductComponents

        public final java.util.List<IProductComponent> getAllProductComponents​(java.lang.String kindId)
        Description copied from interface: IRuntimeRepository
        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.
        Specified by:
        getAllProductComponents in interface IRuntimeRepository
        Parameters:
        kindId - The product component kind id, e.g. CollisionCoverage

      • getAllProductComponents

        protected abstract void getAllProductComponents​(java.lang.String kindId,
                                                java.util.List<IProductComponent> result)
        Same as getAllProductComponent(String kindId) but searches only in this repository and not the ones this repository depends on. Adds the components found to the given result list.

      • getProductComponentGeneration

        public final IProductComponentGeneration getProductComponentGeneration​(java.lang.String id,
                                                                       java.util.Calendar effectiveDate)
        Description copied from interface: IRuntimeRepository
        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.
        Specified by:
        getProductComponentGeneration in interface IRuntimeRepository
        Parameters:
        id - The product component's id.
        effectiveDate - The process' effective date
        Returns:
        The product component generation or null.

      • getProductComponentGenerationInternal

        protected abstract IProductComponentGeneration getProductComponentGenerationInternal​(java.lang.String id,
                                                                                     java.util.Calendar effectiveDate)
        Same as getProductComponentGeneration(String id, Calendar effectiveDate) but searches only in this repository and not the ones this repository depends on.

      • getAllProductComponents

        public final <T extends IProductComponent> java.util.List<T> getAllProductComponents​(java.lang.Class<T> productCmptClass)
        Description copied from interface: IRuntimeRepository
        Returns all product components that are instances of the indicated class. Returns an empty list if no such component exists.
        Specified by:
        getAllProductComponents in interface IRuntimeRepository

      • getAllProductComponentsInternal

        protected <T extends IProductComponent> void getAllProductComponentsInternal​(java.lang.Class<T> productCmptClass,
                                                                             java.util.List<T> result)
        Same as getAllProductComponents(Class) but only searches in own repository not in referenced ones and adding result to parameter result
        Parameters:
        productCmptClass - The class you want to search product components for
        result - adding the found product components to result list

      • getAllProductComponents

        public final java.util.List<IProductComponent> getAllProductComponents()
        Description copied from interface: IRuntimeRepository
        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.

        Specified by:
        getAllProductComponents in interface IRuntimeRepository

      • getAllProductComponents

        protected abstract void getAllProductComponents​(java.util.List<IProductComponent> result)
        Same as getAllProductComponents() but searches only in this repository and not the ones this repository depends on. Adds the components found to the given result list.

      • getProductComponentGenerations

        public final java.util.List<IProductComponentGeneration> getProductComponentGenerations​(IProductComponent productCmpt)
        Description copied from interface: IRuntimeRepository
        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.

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

      • getProductComponentGenerations

        public abstract void getProductComponentGenerations​(IProductComponent productCmpt,
                                                    java.util.List<IProductComponentGeneration> result)
        Same as getProductComponentGenerations() but searches only in this repository and not the ones this repository depends on. Adds the components found to the given result list.

      • getAllProductComponentIds

        public final java.util.List<java.lang.String> getAllProductComponentIds()
        Description copied from interface: IRuntimeRepository
        Returns a list of the IDs of all product components held by this repository or any dependent repository.
        Specified by:
        getAllProductComponentIds in interface IRuntimeRepository
        Returns:
        All valid product component IDs that are accessible by this repository.

      • getAllProductComponentIds

        protected abstract void getAllProductComponentIds​(java.util.List<java.lang.String> result)
        Same as getAllProductComponentIds() but searches only in this repository and not the ones this repository depends on. Adds the components found to the given result list.

      • getAllTables

        public java.util.List<ITable<?>> getAllTables()
        Description copied from interface: IRuntimeRepository
        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.

        Specified by:
        getAllTables in interface IRuntimeRepository

      • getAllTables

        protected abstract void getAllTables​(java.util.List<ITable<?>> result)
        Same as getAllTables() but searches only in this repository and not the ones this repository depends on. Adds the tables found to the given result list.

      • getTable

        public final <T extends ITable<?>> T getTable​(java.lang.Class<T> tableClass)
        Description copied from interface: IRuntimeRepository
        Returns the table contents for the given table class.
        Specified by:
        getTable in interface IRuntimeRepository

      • getTableInternal

        protected abstract <T extends ITable<?>> T getTableInternal​(java.lang.Class<T> tableClass)
        Same as getTable(Class) but searches only in this repository and not the ones this repository depends on.

      • getTable

        public ITable<?> getTable​(java.lang.String qualifiedTableName)
        Description copied from interface: IRuntimeRepository
        Returns the table contents for the given qualified table name.
        Specified by:
        getTable in interface IRuntimeRepository

      • getTableInternal

        protected abstract ITable<?> getTableInternal​(java.lang.String qualifiedTableName)
        Same as getTable(String)) but searches only in this repository and not the ones this repository depends on.

      • getIpsTestCasesStartingWith

        public java.util.List<IpsTest2> getIpsTestCasesStartingWith​(java.lang.String qNamePrefix,
                                                            IRuntimeRepository runtimeRepository)
        Description copied from interface: IRuntimeRepository
        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.
        Specified by:
        getIpsTestCasesStartingWith in interface IRuntimeRepository

      • getAllIpsTestCases

        protected abstract void getAllIpsTestCases​(java.util.List<IpsTest2> result,
                                           IRuntimeRepository runtimeRepository)
        Same as getAllIpsTestCases(IRuntimeRepository) but searches only in this repository and not the ones this repository depends on. Adds the components found to the given result list.

      • getIpsTestCasesStartingWith

        protected abstract void getIpsTestCasesStartingWith​(java.lang.String qNamePrefix,
                                                    java.util.List<IpsTest2> result,
                                                    IRuntimeRepository runtimeRepository)
        Gets all ips test cases starting with the given qualified name prefix.

      • getIpsTest

        public IpsTest2 getIpsTest​(java.lang.String qName)
        Description copied from interface: IRuntimeRepository
        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.
        Specified by:
        getIpsTest in interface IRuntimeRepository

      • getIpsTest

        public IpsTest2 getIpsTest​(java.lang.String qName,
                           IRuntimeRepository runtimeRepository)
        Description copied from interface: IRuntimeRepository
        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.
        Specified by:
        getIpsTest in interface IRuntimeRepository
        See Also:
        IRuntimeRepository.getIpsTestCase(java.lang.String)

      • getIpsTestCase

        public IpsTestCaseBase getIpsTestCase​(java.lang.String qName,
                                      IRuntimeRepository runtimeRepository)
        Description copied from interface: IRuntimeRepository
        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.
        Specified by:
        getIpsTestCase in interface IRuntimeRepository

      • getIpsTestCaseInternal

        protected abstract IpsTestCaseBase getIpsTestCaseInternal​(java.lang.String qName,
                                                          IRuntimeRepository runtimeRepository)
        Same as getIpsTestCase(String, IRuntimeRepository) but searches only in this repository and not the ones this repository depends on. The given runtimeRepository specifies the repository which will be used to instantiate the test case (e.g. the first repository which contains all dependence repositories).

      • getIpsTestSuite

        public IpsTestSuite getIpsTestSuite​(java.lang.String qNamePrefix)
        Description copied from interface: IRuntimeRepository
        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.
        Specified by:
        getIpsTestSuite in interface IRuntimeRepository

      • getIpsTestSuite

        public IpsTestSuite getIpsTestSuite​(java.lang.String qNamePrefix,
                                    IRuntimeRepository runtimeRepository)
        Description copied from interface: IRuntimeRepository
        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.
        Specified by:
        getIpsTestSuite in interface IRuntimeRepository
        See Also:
        IRuntimeRepository.getIpsTestCase(java.lang.String)

      • getNumberOfProductComponentGenerationsInternal

        protected abstract int getNumberOfProductComponentGenerationsInternal​(IProductComponent productCmpt)

      • getModelType

        public Type getModelType​(java.lang.Class<?> modelObjectClass)
        Description copied from interface: IRuntimeRepository
        Returns the IModelType containing the meta information for the given model object class.
        Specified by:
        getModelType in interface IRuntimeRepository

      • getAllModelTypeImplementationClasses

        public final java.util.Set<java.lang.String> getAllModelTypeImplementationClasses()
        Description copied from interface: IRuntimeRepository
        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.

        Specified by:
        getAllModelTypeImplementationClasses in interface IRuntimeRepository

      • getAllModelTypeImplementationClasses

        protected abstract void getAllModelTypeImplementationClasses​(java.util.Set<java.lang.String> result)
        Same as getAllModelTypeImplementationClasses() but searches only in this repository and not the ones this repository depends on. Adds the types found to the given result list.

      • getEnumValue

        @Deprecated
public java.lang.Object getEnumValue​(java.lang.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 returned in future releases.
        Description copied from interface: IRuntimeRepository
        Returns the enumeration value for the provided unique Id. The unique Id is specified as follows qualifiedClassName'#'valueId.
        Specified by:
        getEnumValue in interface IRuntimeRepository

      • getEnumValue

        public final <T> T getEnumValue​(java.lang.Class<T> clazz,
                                java.lang.Object id)
        Description copied from interface: IRuntimeRepository
        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.
        Specified by:
        getEnumValue in interface IRuntimeRepository
        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:
        IRuntimeRepository.getExistingEnumValue(Class, Object)

      • getExistingEnumValue

        public final <T> T getExistingEnumValue​(java.lang.Class<T> clazz,
                                        java.lang.Object id)
        Description copied from interface: IRuntimeRepository
        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 IRuntimeRepository.getEnumValue(Class, Object), this method will throw an exception when no enum value matching the parameters is found in the repository.
        Specified by:
        getExistingEnumValue in interface IRuntimeRepository
        Parameters:
        clazz - The enumeration class upon which the enumeration value is returned
        id - The enum value's identification
        Returns:
        the enumeration value
        See Also:
        IRuntimeRepository.getEnumValue(Class, Object)

      • getEnumValues

        public final <T> java.util.List<T> getEnumValues​(java.lang.Class<T> clazz)
        Description copied from interface: IRuntimeRepository
        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.
        Specified by:
        getEnumValues in interface IRuntimeRepository
        Parameters:
        clazz - the enumeration class upon which the list of enumeration values is returned
        Returns:
        The UNMODIFIABLE list of enum values.

      • getEnumValuesInternal

        protected abstract <T> java.util.List<T> getEnumValuesInternal​(java.lang.Class<T> clazz)
        Returns the list of enumeration values of the enumeration type that is identified by its class which is provided to it.

      • getEnumValuesDefinedInType

        protected <T> java.util.List<T> getEnumValuesDefinedInType​(java.lang.Class<T> enumClass)
        Returns the values that are defined in the type by a constant called 'VALUES'. If no such constant is available an empty list is returned. If the constant is available but is either not accessible or of wrong type an exception is thrown.

        For performance optimization the values are cached in the static map ENUMVALUECACHE. We only check once if there is already a cached value. We disclaim a double checking with synchronization because in worst case two threads simply getting the same result. The ENUMVALUECACHE is realized by a ConcurrentHashMap. Only the first evaluation will be put into the cache using ConcurrentHashMap.putIfAbsent(Object, Object).

        Parameters:
        enumClass - The class of which you want to get the enumeration values
        Returns:
        A list of instances of enumClass that are defined as enumeration values of the specified type.

      • getAllInternalEnumXmlAdapters

        protected abstract java.util.List<javax.xml.bind.annotation.adapters.XmlAdapter<?,​?>> getAllInternalEnumXmlAdapters​(IRuntimeRepository repository)
        Returns all enumeration XmlAdapters available in this repository that generated by Faktor-IPS.
        Parameters:
        repository - the runtime repository that needs to be used by the XmlAdapters that are returned by this method

      • getAllEnumClasses

        public final java.util.List<java.lang.Class<?>> getAllEnumClasses()
        Description copied from interface: IRuntimeRepository
        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 IRuntimeRepository.addDirectlyReferencedRepository(IRuntimeRepository) for their enum structures without content to be found.

        Returns an empty list if no enum class is available.

        Specified by:
        getAllEnumClasses in interface IRuntimeRepository

      • getAllEnumClasses

        protected abstract void getAllEnumClasses​(java.util.LinkedHashSet<java.lang.Class<?>> result)
        Same as getAllEnumClasses() but searches only in this repository and not the ones this repository depends on. Adds the classes found to the given result set.

      • newJAXBContext

        public javax.xml.bind.JAXBContext newJAXBContext​(javax.xml.bind.JAXBContext ctx)
        Creates a JAXBContext that wraps the provided context and extends the marshaling methods to provide marshaling of Faktor-IPS enumerations and model objects configured by product components.

      • newJAXBContext

        public javax.xml.bind.JAXBContext newJAXBContext()
        Creates a new JAXBContext that can marshall / unmarshall all model classes defined in this repository. If the repository references other repositories (directly or indirectly), the context can also handle the classes defined in those.
        Specified by:
        newJAXBContext in interface IRuntimeRepository
        Throws:
        java.lang.RuntimeException - Exceptions that are thrown while trying to load a class from the class loader or creating the jaxb context are wrapped into a runtime exception

      • getCustomRuntimeObject

        public <T> T getCustomRuntimeObject​(java.lang.Class<T> type,
                                    java.lang.String ipsObjectQualifiedName)
        Description copied from interface: IRuntimeRepository
        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.
        Specified by:
        getCustomRuntimeObject in interface IRuntimeRepository
        Parameters:
        type - a class supported by the IRuntimeRepository implementation
        ipsObjectQualifiedName - the qualified name of the object
        Returns:
        the object identified by qName or null

      • getCustomRuntimeObjectInternal

        protected abstract <T> T getCustomRuntimeObjectInternal​(java.lang.Class<T> type,
                                                        java.lang.String ipsObjectQualifiedName)
        Same as getCustomRuntimeObject(Class, String) but searches only in this repository and not the ones this repository depends on.