Package org.faktorips.runtime

Class InMemoryRuntimeRepository

java.lang.Object

org.faktorips.runtime.internal.AbstractRuntimeRepository

org.faktorips.runtime.InMemoryRuntimeRepository

All Implemented Interfaces:

IModifiableRuntimeRepository, IRuntimeRepository

public class InMemoryRuntimeRepository
extends AbstractRuntimeRepository
implements IModifiableRuntimeRepository

A runtime repository that keeps its data in memory.

Constructor Summary

Constructors

Constructor	Description
InMemoryRuntimeRepository()
InMemoryRuntimeRepository(String name)

Method Summary

Modifier and Type	Method	Description
void	addEnumXmlAdapter(IIpsXmlAdapter<?,?> enumXmlAdapter)	Adds an IIpsXmlAdapter for a Faktor-IPS enumeration that defers its content to a enumeration content to this repository.
protected void	getAllEnumClasses(LinkedHashSet<Class<?>> result)	Same as AbstractRuntimeRepository.getAllEnumClasses() but searches only in this repository and not the ones this repository depends on.
protected List<IIpsXmlAdapter<?,?>>	getAllInternalEnumXmlAdapters(IRuntimeRepository repository)	Returns all enumeration XmlAdapters available in this repository that generated by Faktor-IPS.
protected void	getAllIpsTestCases(List<IpsTest2> result, IRuntimeRepository runtimeRepository)	Same as AbstractRuntimeRepository.getAllIpsTestCases(IRuntimeRepository) but searches only in this repository and not the ones this repository depends on.
protected void	getAllModelTypeImplementationClasses(Set<String> result)	Same as AbstractRuntimeRepository.getAllModelTypeImplementationClasses() but searches only in this repository and not the ones this repository depends on.
void	getAllProductComponentIds(List<String> result)	Same as AbstractRuntimeRepository.getAllProductComponentIds() but searches only in this repository and not the ones this repository depends on.
void	getAllProductComponents(String kindId, List<IProductComponent> result)	Same as getAllProductComponent(String kindId) but searches only in this repository and not the ones this repository depends on.
void	getAllProductComponents(List<IProductComponent> result)	Same as getAllProductComponents() but searches only in this repository and not the ones this repository depends on.
void	getAllTableIds(List<String> result)	Same as AbstractRuntimeRepository.getAllTableIds() but searches only in this repository and not the ones this repository depends on.
protected void	getAllTables(List<ITable<?>> result)	Same as AbstractRuntimeRepository.getAllTables() but searches only in this repository and not the ones this repository depends on.
protected <T> T	getCustomRuntimeObjectInternal(Class<T> type, String ipsObjectQualifiedName)	Same as AbstractRuntimeRepository.getCustomRuntimeObject(Class, String) but searches only in this repository and not the ones this repository depends on.
<T> org.faktorips.values.InternationalString	getEnumDescription(Class<T> enumClazz)	Returns the description for the given enumeration type.
protected <T> List<T>	getEnumValuesInternal(Class<T> clazz)	Returns the list of enumeration values of the enumeration type that is identified by its class which is provided to it.
protected IpsTestCaseBase	getIpsTestCaseInternal(String qName, IRuntimeRepository runtimeRepository)	Same as AbstractRuntimeRepository.getIpsTestCase(String, IRuntimeRepository) but searches only in this repository and not the ones this repository depends on.
protected void	getIpsTestCasesStartingWith(String qNamePrefix, List<IpsTest2> result, IRuntimeRepository runtimeRepository)	Gets all ips test cases starting with the given qualified name prefix.
protected IProductComponentGeneration	getLatestProductComponentGenerationInternal(IProductComponent productCmpt)
protected IProductComponentGeneration	getNextProductComponentGenerationInternal(IProductComponentGeneration generation)
protected int	getNumberOfProductComponentGenerationsInternal(IProductComponent productCmpt)
protected IProductComponentGeneration	getPreviousProductComponentGenerationInternal(IProductComponentGeneration generation)
protected IProductComponentGeneration	getProductComponentGenerationInternal(String productCmptId, Calendar effectiveDate)	Same as getProductComponentGeneration(String id, Calendar effectiveDate) but searches only in this repository and not the ones this repository depends on.
void	getProductComponentGenerations(IProductComponent productCmpt, List<IProductComponentGeneration> result)	Same as getProductComponentGenerations() but searches only in this repository and not the ones this repository depends on.
protected IProductComponent	getProductComponentInternal(String id)	Same as getProductComponent(String id) but searches only in this repository and not the ones this repository depends on.
protected IProductComponent	getProductComponentInternal(String kindId, String versionId)	Same as getProductComponent(String kindId, String versionId) but searches only in this repository and not the ones this repository depends on.
protected <T extends ITable<?>> T	getTableInternal(Class<T> tableClass)	InMemoryRepository also searches for tables that are instances of subclasses of the given tableClass.
protected ITable<?>	getTableInternal(String qualifiedTableName)	Same as AbstractRuntimeRepository.getTable(String)) but searches only in this repository and not the ones this repository depends on.
void	initialize()	Nothing to do for the in memory repository.
boolean	isModifiable()	Returns true if the repository's content is modifiable.
<T extends IRuntimeObject> void	putCustomRuntimeObject(Class<T> type, String ipsObjectQualifiedName, T runtimeObject)	Puts the runtimeObject into the repository.
<T> void	putEnumValues(Class<T> enumTypeClass, List<T> enumValues, org.faktorips.values.InternationalString description)	Puts the given enum values and description in the repository replacing all existing values for the given enumType.
void	putIpsTestCase(IpsTestCaseBase test)	Puts the test case into the repository.
void	putProductCmptGeneration(IProductComponentGeneration generation)	Puts the product component generation and its product component into the repository.
void	putProductComponent(IProductComponent productCmpt)	Puts the product component into the repository.
Optional<ITable<?>>	putTable(ITable<?> table)	Puts the table into the repository.
void	putTable(ITable<?> table, String qName)	Deprecated, for removal: This API element is subject to removal in a future version. since 24.7 for removal.
<T> boolean	removeCustomRuntimeObject(Class<T> type, String ipsObjectQualifiedName)	removes the runtimeObject from the repository.
<T> boolean	removeEnumValues(Class<T> enumTypeClass)	removes the enum values and description of the given enumType from the repository.
boolean	removeIpsTestCase(IpsTestCaseBase test)	Removes the specified IPS test case.
boolean	removeProductCmptGeneration(IProductComponentGeneration productCmptGeneration)	Removes the given product component generation from the list of generations
boolean	removeProductComponent(IProductComponent productCmpt)	Removes the product component from the repository.
boolean	removeTable(ITable<?> table)	Removes the table from the repository.

Methods inherited from class org.faktorips.runtime.internal.AbstractRuntimeRepository

addAllEnumXmlAdapters, addDirectlyReferencedRepository, addEnumValueLookupService, getAllEnumClasses, getAllIpsTestCases, getAllModelTypeImplementationClasses, getAllProductComponentIds, getAllProductComponents, getAllProductComponents, getAllProductComponents, getAllProductComponentsInternal, getAllReferencedRepositories, getAllTableIds, getAllTables, getClassLoader, getCustomRuntimeObject, getDirectlyReferencedRepositories, getEnumValue, getEnumValue, getEnumValueLookupService, getEnumValues, getEnumValuesDefinedInType, getExistingEnumValue, getExistingProductComponent, getExistingProductComponentGeneration, getFormulaEvaluatorFactory, getIpsTest, getIpsTest, getIpsTestCase, getIpsTestCase, getIpsTestCasesStartingWith, getIpsTestSuite, getIpsTestSuite, getLatestProductComponentGeneration, getModelType, getModelType, getModelType, getName, getNextProductComponentGeneration, getNumberOfProductComponentGenerations, getPreviousProductComponentGeneration, getProductComponent, getProductComponent, getProductComponentGeneration, getProductComponentGenerations, getRuntimeRepositoryLookup, getTable, getTable, isMultiContent, newJAXBContext, newJAXBContext, removeEnumValueLookupService, setFormulaEvaluatorFactory, setRuntimeRepositoryLookup, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.faktorips.runtime.IModifiableRuntimeRepository

putEnumValues

Methods inherited from interface org.faktorips.runtime.IRuntimeRepository

addDirectlyReferencedRepository, addEnumValueLookupService, getAllEnumClasses, getAllIpsTestCases, getAllModelTypeImplementationClasses, getAllProductComponentIds, getAllProductComponents, getAllProductComponents, getAllProductComponents, getAllReferencedRepositories, getAllTableIds, getAllTables, getClassLoader, getCustomRuntimeObject, getDirectlyReferencedRepositories, getEnumValue, getEnumValue, getEnumValueLookupService, getEnumValues, getExistingEnumValue, getExistingProductComponent, getExistingProductComponentGeneration, getFormulaEvaluatorFactory, getIpsTest, getIpsTest, getIpsTestCase, getIpsTestCase, getIpsTestCasesStartingWith, getIpsTestSuite, getIpsTestSuite, getLatestProductComponentGeneration, getModelType, getModelType, getModelType, getName, getNextProductComponentGeneration, getNumberOfProductComponentGenerations, getPreviousProductComponentGeneration, getProductComponent, getProductComponent, getProductComponentGeneration, getProductComponentGenerations, getRuntimeRepositoryLookup, getTable, getTable, newJAXBContext, removeEnumValueLookupService, setRuntimeRepositoryLookup

Constructor Details

InMemoryRuntimeRepository

public InMemoryRuntimeRepository()

InMemoryRuntimeRepository

public InMemoryRuntimeRepository(String name)

Method Details

getProductComponentInternal

protected IProductComponent getProductComponentInternal(String id)

Description copied from class: AbstractRuntimeRepository

Same as getProductComponent(String id) but searches only in this repository and not the ones this repository depends on.

Specified by:

getProductComponentInternal in class AbstractRuntimeRepository

getProductComponentInternal

protected IProductComponent getProductComponentInternal(String kindId,
 String versionId)

Description copied from class: AbstractRuntimeRepository

Same as getProductComponent(String kindId, String versionId) but searches only in this repository and not the ones this repository depends on.

Specified by:

getProductComponentInternal in class AbstractRuntimeRepository

getAllProductComponents

public void getAllProductComponents(String kindId,
 List<IProductComponent> result)

Description copied from class: AbstractRuntimeRepository

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.

Specified by:

getAllProductComponents in class AbstractRuntimeRepository

getProductComponentGenerations

public void getProductComponentGenerations(IProductComponent productCmpt,
 List<IProductComponentGeneration> result)

Description copied from class: AbstractRuntimeRepository

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.

Specified by:

getProductComponentGenerations in class AbstractRuntimeRepository

initialize

public void initialize()

Nothing to do for the in memory repository.

getAllTables

protected void getAllTables(List<ITable<?>> result)

Description copied from class: AbstractRuntimeRepository

Same as AbstractRuntimeRepository.getAllTables() but searches only in this repository and not the ones this repository depends on. Adds the tables found to the given result list.

Specified by:

getAllTables in class AbstractRuntimeRepository

getAllTableIds

public void getAllTableIds(List<String> result)

Description copied from class: AbstractRuntimeRepository

Same as AbstractRuntimeRepository.getAllTableIds() but searches only in this repository and not the ones this repository depends on. Adds the tables found to the given result list.

Specified by:

getAllTableIds in class AbstractRuntimeRepository

getTableInternal

protected <T extends ITable<?>> T getTableInternal(Class<T> tableClass)

InMemoryRepository also searches for tables that are instances of subclasses of the given tableClass. This allows to mock a table class for testing purposes.

Same as AbstractRuntimeRepository.getTable(Class) but searches only in this repository and not the ones this repository depends on.

Specified by:

getTableInternal in class AbstractRuntimeRepository

putTable

public Optional<ITable<?>> putTable(ITable<?> table)

Puts the table into the repository. Replaces any table instance of the same class or any of its superclasses. The latter check is needed to replace tables with mock implementations.

Specified by:

putTable in interface IModifiableRuntimeRepository

Returns:

an Optional containing the old single content table if a single content table of the same class has been replaced, or an empty Optional if a multi-content table has been added.

Throws:

NullPointerException - if table is null.

putTable

@Deprecated(since="24.7",
            forRemoval=true)
public void putTable(ITable<?> table,
 String qName)

Deprecated, for removal: This API element is subject to removal in a future version.

since 24.7 for removal. Use IModifiableRuntimeRepository.putTable(ITable) for all kinds of tables and make sure the qName is set as the table's name.

Puts the table with the indicated name into the repository. Replaces any table instance with the same qualified name.

Throws:

NullPointerException - if table or qName is null.

putEnumValues

public <T> void putEnumValues(Class<T> enumTypeClass,
 List<T> enumValues,
 org.faktorips.values.InternationalString description)

Description copied from interface: IModifiableRuntimeRepository

Puts the given enum values and description in the repository replacing all existing values for the given enumType.

Specified by:

putEnumValues in interface IModifiableRuntimeRepository

Parameters:

enumTypeClass - the Java class representing the enumeration type

enumValues - the value of the enumeration type as list

description - the description of the enumeration

removeEnumValues

public <T> boolean removeEnumValues(Class<T> enumTypeClass)

Description copied from interface: IModifiableRuntimeRepository

removes the enum values and description of the given enumType from the repository.

Specified by:

removeEnumValues in interface IModifiableRuntimeRepository

Parameters:

enumTypeClass - the Java class representing the enumeration type

Returns:

whether the given enum type was part of this repository and was successfully removed

getEnumDescription

public <T> org.faktorips.values.InternationalString getEnumDescription(Class<T> enumClazz)

Description copied from interface: IRuntimeRepository

Returns the description for the given enumeration type.

Specified by:

getEnumDescription in interface IRuntimeRepository

Type Parameters:

T - The enum type

Parameters:

enumClazz - the enum type's class

getTableInternal

protected ITable<?> getTableInternal(String qualifiedTableName)

Description copied from class: AbstractRuntimeRepository

Same as AbstractRuntimeRepository.getTable(String)) but searches only in this repository and not the ones this repository depends on.

Specified by:

getTableInternal in class AbstractRuntimeRepository

getAllProductComponents

public void getAllProductComponents(List<IProductComponent> result)

Description copied from class: AbstractRuntimeRepository

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.

Specified by:

getAllProductComponents in class AbstractRuntimeRepository

getAllProductComponentIds

public void getAllProductComponentIds(List<String> result)

Description copied from class: AbstractRuntimeRepository

Same as AbstractRuntimeRepository.getAllProductComponentIds() but searches only in this repository and not the ones this repository depends on. Adds the components found to the given result list.

Specified by:

getAllProductComponentIds in class AbstractRuntimeRepository

getAllEnumClasses

protected void getAllEnumClasses(LinkedHashSet<Class<?>> result)

Description copied from class: AbstractRuntimeRepository

Same as AbstractRuntimeRepository.getAllEnumClasses() but searches only in this repository and not the ones this repository depends on. Adds the classes found to the given result set.

Specified by:

getAllEnumClasses in class AbstractRuntimeRepository

isModifiable

public boolean isModifiable()

Description copied from interface: IRuntimeRepository

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.

Specified by:

isModifiable in interface IRuntimeRepository

putProductComponent

public void putProductComponent(IProductComponent productCmpt)

Puts the product component into the repository. If the repository already contains a component with the same id, the new component replaces the old one.

Specified by:

putProductComponent in interface IModifiableRuntimeRepository

Throws:

IllegalRepositoryModificationException - if this repository does not allows to modify

NullPointerException - if productCmpt is null its contents.

See Also:

• IRuntimeRepository.isModifiable()

removeProductComponent

public boolean removeProductComponent(IProductComponent productCmpt)

Description copied from interface: IModifiableRuntimeRepository

Removes the product component from the repository.

Specified by:

removeProductComponent in interface IModifiableRuntimeRepository

Returns:

whether the given product component was part of this repository

See Also:

• IRuntimeRepository.isModifiable()

removeTable

public boolean removeTable(ITable<?> table)

Description copied from interface: IModifiableRuntimeRepository

Removes the table from the repository.

Specified by:

removeTable in interface IModifiableRuntimeRepository

Returns:

whether the given table component was part of this repository

removeProductCmptGeneration

public boolean removeProductCmptGeneration(IProductComponentGeneration productCmptGeneration)

Description copied from interface: IModifiableRuntimeRepository

Removes the given product component generation from the list of generations

Specified by:

removeProductCmptGeneration in interface IModifiableRuntimeRepository

Parameters:

productCmptGeneration - the product component generation to be removed;

Returns:

true if the product component generation was successfully removed, false if the generation was not found in the list of generations.

removeIpsTestCase

public boolean removeIpsTestCase(IpsTestCaseBase test)

Description copied from interface: IModifiableRuntimeRepository

Removes the specified IPS test case.

Specified by:

removeIpsTestCase in interface IModifiableRuntimeRepository

Parameters:

test - the IPS test case to be removed. It must not be null.

Returns:

true if the test case was successfully removed, false if no test case with the given test case's qualified name exists.

getProductComponentGenerationInternal

protected IProductComponentGeneration getProductComponentGenerationInternal(String productCmptId,
 Calendar effectiveDate)

Description copied from class: AbstractRuntimeRepository

Same as getProductComponentGeneration(String id, Calendar effectiveDate) but searches only in this repository and not the ones this repository depends on.

Specified by:

getProductComponentGenerationInternal in class AbstractRuntimeRepository

putProductCmptGeneration

public void putProductCmptGeneration(IProductComponentGeneration generation)

Puts the product component generation and its product component into the repository. If the repository already contains a generation with the same id, the new component replaces the old one. The same applies for the product component.

Specified by:

putProductCmptGeneration in interface IModifiableRuntimeRepository

Throws:

IllegalRepositoryModificationException - if this repository does not allows to modify its contents.

NullPointerException - if generation is null

See Also:

• IRuntimeRepository.isModifiable()

getAllIpsTestCases

protected void getAllIpsTestCases(List<IpsTest2> result,
 IRuntimeRepository runtimeRepository)

Description copied from class: AbstractRuntimeRepository

Same as AbstractRuntimeRepository.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.

Specified by:

getAllIpsTestCases in class AbstractRuntimeRepository

getIpsTestCasesStartingWith

protected void getIpsTestCasesStartingWith(String qNamePrefix,
 List<IpsTest2> result,
 IRuntimeRepository runtimeRepository)

Description copied from class: AbstractRuntimeRepository

Gets all ips test cases starting with the given qualified name prefix.

Specified by:

getIpsTestCasesStartingWith in class AbstractRuntimeRepository

getIpsTestCaseInternal

protected IpsTestCaseBase getIpsTestCaseInternal(String qName,
 IRuntimeRepository runtimeRepository)

Description copied from class: AbstractRuntimeRepository

Same as AbstractRuntimeRepository.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).

Specified by:

getIpsTestCaseInternal in class AbstractRuntimeRepository

putIpsTestCase

public void putIpsTestCase(IpsTestCaseBase test)

Puts the test case into the repository.

Specified by:

putIpsTestCase in interface IModifiableRuntimeRepository

getAllModelTypeImplementationClasses

protected void getAllModelTypeImplementationClasses(Set<String> result)

Description copied from class: AbstractRuntimeRepository

Same as AbstractRuntimeRepository.getAllModelTypeImplementationClasses() but searches only in this repository and not the ones this repository depends on. Adds the types found to the given result list.

Specified by:

getAllModelTypeImplementationClasses in class AbstractRuntimeRepository

getNextProductComponentGenerationInternal

protected IProductComponentGeneration getNextProductComponentGenerationInternal(IProductComponentGeneration generation)

Specified by:

getNextProductComponentGenerationInternal in class AbstractRuntimeRepository

getNumberOfProductComponentGenerationsInternal

protected int getNumberOfProductComponentGenerationsInternal(IProductComponent productCmpt)

Specified by:

getNumberOfProductComponentGenerationsInternal in class AbstractRuntimeRepository

getPreviousProductComponentGenerationInternal

protected IProductComponentGeneration getPreviousProductComponentGenerationInternal(IProductComponentGeneration generation)

Specified by:

getPreviousProductComponentGenerationInternal in class AbstractRuntimeRepository

getLatestProductComponentGenerationInternal

protected IProductComponentGeneration getLatestProductComponentGenerationInternal(IProductComponent productCmpt)

Specified by:

getLatestProductComponentGenerationInternal in class AbstractRuntimeRepository

getEnumValuesInternal

protected <T> List<T> getEnumValuesInternal(Class<T> clazz)

Description copied from class: AbstractRuntimeRepository

Returns the list of enumeration values of the enumeration type that is identified by its class which is provided to it.

Specified by:

getEnumValuesInternal in class AbstractRuntimeRepository

addEnumXmlAdapter

public void addEnumXmlAdapter(IIpsXmlAdapter<?,?> enumXmlAdapter)

Adds an IIpsXmlAdapter for a Faktor-IPS enumeration that defers its content to a enumeration content to this repository.

getAllInternalEnumXmlAdapters

protected List<IIpsXmlAdapter<?,?>> getAllInternalEnumXmlAdapters(IRuntimeRepository repository)

Description copied from class: AbstractRuntimeRepository

Returns all enumeration XmlAdapters available in this repository that generated by Faktor-IPS.

Specified by:

getAllInternalEnumXmlAdapters in class AbstractRuntimeRepository

Parameters:

repository - the runtime repository that needs to be used by the XmlAdapters that are returned by this method

putCustomRuntimeObject

public <T extends IRuntimeObject> void putCustomRuntimeObject(Class<T> type,
 String ipsObjectQualifiedName,
 T runtimeObject)

Puts the runtimeObject into the repository.

Specified by:

putCustomRuntimeObject in interface IModifiableRuntimeRepository

getCustomRuntimeObjectInternal

protected <T> T getCustomRuntimeObjectInternal(Class<T> type,
 String ipsObjectQualifiedName)

Description copied from class: AbstractRuntimeRepository

Same as AbstractRuntimeRepository.getCustomRuntimeObject(Class, String) but searches only in this repository and not the ones this repository depends on.

Specified by:

getCustomRuntimeObjectInternal in class AbstractRuntimeRepository

removeCustomRuntimeObject

public <T> boolean removeCustomRuntimeObject(Class<T> type,
 String ipsObjectQualifiedName)

Description copied from interface: IModifiableRuntimeRepository

removes the runtimeObject from the repository.

Specified by:

removeCustomRuntimeObject in interface IModifiableRuntimeRepository

Parameters:

type - the Java class representing the runtime object

ipsObjectQualifiedName - the qualified name of the runtime object

Returns:

whether the given runtime object was part of this repository