Package com.hybris.cockpitng.core.persistence.impl

Class DefaultConfigurationImportSupport

java.lang.Object

com.hybris.cockpitng.core.persistence.impl.DefaultConfigurationImportSupport

All Implemented Interfaces:

ConfigurationImportSupport

public class DefaultConfigurationImportSupport
extends java.lang.Object
implements ConfigurationImportSupport

A default tooling class to support importing configuration among different files

Constructor Summary

Constructors

Constructor	Description
DefaultConfigurationImportSupport()

Method Summary

Modifier and Type	Method	Description
protected <C> C	applyImport(Import resourceImport, java.io.File currentPath, C root, ConfigurationInterpreter<C> interpreter, java.util.Set<java.lang.String> resolvedResources)
protected <C> boolean	checkRequirements(java.io.File currentPath, C root, ConfigurationInterpreter<C> interpreter, java.util.Set<java.lang.String> resolvedResources)
protected java.io.File	getImportRootFile()
protected TemplateEngine	getTemplateEngine()
protected <C> java.util.Set<java.lang.String>	getUndefinedParameters(C root, ConfigurationInterpreter<C> interpreter, java.util.Set<java.lang.String> definedValues)
protected <C> C	loadImports(java.io.File currentPath, C root, ConfigurationInterpreter<C> interpreter, java.util.Set<java.lang.String> resolvedResources)
<C> C	resolveImports(C root, ConfigurationInterpreter<C> interpreter)	Resolves all imports defined in specified root configuration.
protected java.io.InputStream	resolveResource(java.lang.String resourcePath, java.util.Map<java.lang.String,java.lang.Object> resourceParameters)
protected java.lang.String	resolveResourcePath(java.io.File resource)
void	setImportRootFile(java.lang.String importRootFile)
void	setTemplateEngine(TemplateEngine templateEngine)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultConfigurationImportSupport

public DefaultConfigurationImportSupport()

Method Detail

resolveImports

public <C> C resolveImports(C root,
                            ConfigurationInterpreter<C> interpreter)
                     throws java.io.IOException

Description copied from interface: ConfigurationImportSupport

Resolves all imports defined in specified root configuration. All nested imports are also resolved.

Specified by:

resolveImports in interface ConfigurationImportSupport

Type Parameters:

C - type of configuration root

Parameters:

root - root configuration, which imports are to be resolved

interpreter - an object capable of extracting information from configuration and modifying it

Returns:

root configuration merged with all imported onces

Throws:

java.io.IOException

loadImports

protected <C> C loadImports(java.io.File currentPath,
                            C root,
                            ConfigurationInterpreter<C> interpreter,
                            java.util.Set<java.lang.String> resolvedResources)
                     throws java.io.IOException

Throws:

java.io.IOException

applyImport

protected <C> C applyImport(Import resourceImport,
                            java.io.File currentPath,
                            C root,
                            ConfigurationInterpreter<C> interpreter,
                            java.util.Set<java.lang.String> resolvedResources)
                     throws java.io.IOException

Throws:

java.io.IOException

resolveResourcePath

protected java.lang.String resolveResourcePath(java.io.File resource)
                                        throws java.io.IOException

Throws:

java.io.IOException

checkRequirements

protected <C> boolean checkRequirements(java.io.File currentPath,
                                        C root,
                                        ConfigurationInterpreter<C> interpreter,
                                        java.util.Set<java.lang.String> resolvedResources)

resolveResource

protected java.io.InputStream resolveResource(java.lang.String resourcePath,
                                              java.util.Map<java.lang.String,java.lang.Object> resourceParameters)
                                       throws java.io.IOException

Throws:

java.io.IOException

getUndefinedParameters

protected <C> java.util.Set<java.lang.String> getUndefinedParameters(C root,
                                                                     ConfigurationInterpreter<C> interpreter,
                                                                     java.util.Set<java.lang.String> definedValues)

getImportRootFile

protected java.io.File getImportRootFile()

setImportRootFile

public void setImportRootFile(java.lang.String importRootFile)

setTemplateEngine

public void setTemplateEngine(TemplateEngine templateEngine)

getTemplateEngine

protected TemplateEngine getTemplateEngine()