Package org.faktorips.runtime.internal

Class AbstractXmlInputStreamRepository

java.lang.Object

org.faktorips.runtime.internal.AbstractRuntimeRepository

org.faktorips.runtime.internal.AbstractCachingRuntimeRepository

org.faktorips.runtime.internal.AbstractTocBasedRuntimeRepository

org.faktorips.runtime.internal.AbstractXmlInputStreamRepository

All Implemented Interfaces:

IRuntimeRepository

Direct Known Subclasses:

AbstractClassLoadingRuntimeRepository

public abstract class AbstractXmlInputStreamRepository
extends AbstractTocBasedRuntimeRepository

An abstract repository that handles loading Faktor-IPS runtime information from XML as InputStreams. The concrete runtime repositories provide these streams, for example the ClassloaderRuntimeRepository uses ClassLoader.getResourceAsStream(String) to load the XML resources.

Constructor Summary

Constructors

Constructor	Description
AbstractXmlInputStreamRepository(String name, ICacheFactory cacheFactory, ClassLoader cl)

Method Summary

Modifier and Type	Method	Description
protected <T> T	createCustomObject(CustomTocEntryObject<T> tocEntry)
protected <T> IpsEnum<T>	createEnumValues(EnumContentTocEntry tocEntry, Class<T> enumClass)
protected IProductComponent	createProductCmpt(ProductCmptTocEntry tocEntry)
protected IProductComponentGeneration	createProductCmptGeneration(GenerationTocEntry generationTocEntry)
protected ProductComponentGeneration	createProductComponentGenerationInstance(GenerationTocEntry tocEntry, ProductComponent productCmpt)
protected ProductComponent	createProductComponentInstance(String implementationClassName, String ipsObjectId, String kindId, String versionId)
protected ITable<?>	createTable(TableContentTocEntry tocEntry)	Creates the table object for the given toc entry.
protected IpsTestCaseBase	createTestCase(TestCaseTocEntry tocEntry, IRuntimeRepository runtimeRepository)	Creates the test case object for the given toc entry.
protected <T> Element	getDocumentElement(CustomTocEntryObject<T> tocEntry)	This method returns the xml element of the ips object identified by the tocEntry
protected Element	getDocumentElement(GenerationTocEntry tocEntry)	This method returns the xml element of the product component generation identified by the tocEntry
protected Element	getDocumentElement(ProductCmptTocEntry tocEntry)	This method returns the xml element of the product component identified by the tocEntry
protected Element	getDocumentElement(TestCaseTocEntry tocEntry)	This method returns the xml element of the test case identified by the tocEntry
protected ProductVariantRuntimeHelper	getProductVariantHelper()
protected abstract InputStream	getXmlAsStream(EnumContentTocEntry tocEntry)	Returns the XML data for the specified EnumContentTocEntry as InputStream
protected abstract InputStream	getXmlAsStream(TableContentTocEntry tocEntry)	Returns the XML data for the specified TableContentTocEntry as InputStream
protected abstract InputStream	getXmlAsStream(TocEntry tocEntry)	Returns the XML data for the specified TocEntry as InputStream

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

createEnumXmlAdapter, getAllEnumClasses, getAllIpsTestCases, getAllModelTypeImplementationClasses, getAllProductComponentIds, getAllProductComponents, getAllProductComponents, getAllTables, getClass, getIpsTestCaseInternal, getIpsTestCasesStartingWith, getLatestProductComponentGenerationInternal, getNextProductComponentGenerationInternal, getNotCachedCustomObject, getNotCachedEnumValues, getNotCachedEnumXmlAdapter, getNotCachedProductComponent, getNotCachedProductComponentGeneration, getNotCachedTable, getNumberOfProductComponentGenerationsInternal, getPreviousProductComponentGenerationInternal, getProductComponentGenerationInternal, getProductComponentGenerations, getProductComponentInternal, getTableInternal, getTableOfContents, initialize, loadTableOfContents

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

getAllInternalEnumXmlAdapters, getCustomRuntimeObjectInternal, getEnumDescription, getEnumValuesInternal, getProductComponentGenerationInternal, getProductComponentInternal, getTableInternal, initCaches

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

addAllEnumXmlAdapters, addDirectlyReferencedRepository, addEnumValueLookupService, getAllEnumClasses, getAllIpsTestCases, getAllModelTypeImplementationClasses, getAllProductComponentIds, getAllProductComponents, getAllProductComponents, getAllProductComponents, getAllProductComponentsInternal, getAllReferencedRepositories, 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, 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.IRuntimeRepository

isModifiable

Constructor Details

AbstractXmlInputStreamRepository

public AbstractXmlInputStreamRepository(String name,
 ICacheFactory cacheFactory,
 ClassLoader cl)

Method Details

getXmlAsStream

protected abstract InputStream getXmlAsStream(EnumContentTocEntry tocEntry)

Returns the XML data for the specified EnumContentTocEntry as InputStream

Parameters:

tocEntry - Specifying the requested EnumContent

Returns:

An InputStream containing the XML data - should not return null!

Throws:

RuntimeException - in case of any exception do not return null but an accurate RuntimeException

getXmlAsStream

protected abstract InputStream getXmlAsStream(TableContentTocEntry tocEntry)

Returns the XML data for the specified TableContentTocEntry as InputStream

Parameters:

tocEntry - Specifying the requested TableContent

Returns:

An InputStream containing the XML data - should not return null!

Throws:

RuntimeException - in case of any exception do not return null but an accurate RuntimeException

getXmlAsStream

protected abstract InputStream getXmlAsStream(TocEntry tocEntry)

Returns the XML data for the specified TocEntry as InputStream

Parameters:

tocEntry - Specifying the requested ips object

Returns:

An InputStream containing the XML data - should not return null!

Throws:

RuntimeException - in case of any exception do not return null but an accurate RuntimeException

getProductVariantHelper

protected ProductVariantRuntimeHelper getProductVariantHelper()

createEnumValues

protected <T> IpsEnum<T> createEnumValues(EnumContentTocEntry tocEntry,
 Class<T> enumClass)

Specified by:

createEnumValues in class AbstractTocBasedRuntimeRepository

createProductCmpt

protected IProductComponent createProductCmpt(ProductCmptTocEntry tocEntry)

Specified by:

createProductCmpt in class AbstractTocBasedRuntimeRepository

createProductCmptGeneration

protected IProductComponentGeneration createProductCmptGeneration(GenerationTocEntry generationTocEntry)

Specified by:

createProductCmptGeneration in class AbstractTocBasedRuntimeRepository

createTable

protected ITable<?> createTable(TableContentTocEntry tocEntry)

Description copied from class: AbstractTocBasedRuntimeRepository

Creates the table object for the given toc entry.

Specified by:

createTable in class AbstractTocBasedRuntimeRepository

createTestCase

protected IpsTestCaseBase createTestCase(TestCaseTocEntry tocEntry,
 IRuntimeRepository runtimeRepository)

Description copied from class: AbstractTocBasedRuntimeRepository

Creates the test case object for the given toc entry.

Specified by:

createTestCase in class AbstractTocBasedRuntimeRepository

createCustomObject

protected <T> T createCustomObject(CustomTocEntryObject<T> tocEntry)

Specified by:

createCustomObject in class AbstractTocBasedRuntimeRepository

getDocumentElement

protected Element getDocumentElement(GenerationTocEntry tocEntry)

This method returns the xml element of the product component generation identified by the tocEntry

getDocumentElement

protected Element getDocumentElement(ProductCmptTocEntry tocEntry)

This method returns the xml element of the product component identified by the tocEntry

getDocumentElement

protected Element getDocumentElement(TestCaseTocEntry tocEntry)

This method returns the xml element of the test case identified by the tocEntry

getDocumentElement

protected <T> Element getDocumentElement(CustomTocEntryObject<T> tocEntry)

This method returns the xml element of the ips object identified by the tocEntry

createProductComponentGenerationInstance

protected ProductComponentGeneration createProductComponentGenerationInstance(GenerationTocEntry tocEntry,
 ProductComponent productCmpt)

createProductComponentInstance

protected ProductComponent createProductComponentInstance(String implementationClassName,
 String ipsObjectId,
 String kindId,
 String versionId)