org.apache.isis.core.metamodel.specloader

Class ObjectReflectorDefault

java.lang.Object

org.apache.isis.core.metamodel.specloader.ObjectReflectorDefault

All Implemented Interfaces:

ApplicationScopedComponent, Component, Injectable, Debuggable, DebuggableWithTitle, RuntimeContextAware, SpecificationLoader, SpecificationLoaderSpi

public final class ObjectReflectorDefault
extends Object
implements SpecificationLoaderSpi, ApplicationScopedComponent, RuntimeContextAware, DebuggableWithTitle

Builds the meta-model.

The implementation provides for a degree of pluggability:

• The most important plug-in point is ProgrammingModel that specifies the set of Facet that make up programming model. If not specified then defaults to ProgrammingModelFacetsJava5 (which should be used as a starting point for your own customizations).
• The only mandatory plug-in point is ClassSubstitutor, which allows the class to be loaded to be substituted if required. This is used in conjunction with some PersistenceMechanisms that do class enhancement.
• The CollectionTypeRegistry specifies the types that should be considered as collections. If not specified then will default. (Note: this extension point has not been tested, so should be considered more of a "statement of intent" than actual API. Also, we may use annotations (similar to the way in which Values are specified) as an alternative mechanism).

In addition, the RuntimeContext can optionally be injected, but will default to RuntimeContextNoRuntime if not provided prior to initialization. The purpose of RuntimeContext is to allow the metamodel to be used standalone, for example in a Maven plugin. The RuntimeContextNoRuntime implementation will through an exception for any methods (such as finding an adapter) because there is no runtime session. In the case of the metamodel being used by the framework (that is, when there is a runtime), then the framework injects an implementation of RuntimeContext that acts like a bridge to its IsisContext.

Constructor Summary

Constructors

Constructor and Description
ObjectReflectorDefault(IsisConfiguration configuration, ClassSubstitutor classSubstitutor, CollectionTypeRegistry collectionTypeRegistry, SpecificationTraverser specificationTraverser, ProgrammingModel programmingModel, Set<FacetDecorator> facetDecorators, MetaModelValidator metaModelValidator)

Method Summary

Methods

Modifier and Type	Method and Description
Collection<ObjectSpecification>	allSpecifications() Return all the loaded specifications.
void	debugData(DebugBuilder debug) Debug details describing the object being investigated
String	debugTitle() The title for the debug information
protected void	finalize()
protected ClassSubstitutor	getClassSubstitutor()
protected CollectionTypeRegistry	getCollectionTypeRegistry()
protected Set<FacetDecorator>	getFacetDecoratorSet()
FacetProcessor	getFacetProcessor() Provides access to the registered Facets.
protected IsisConfiguration	getIsisConfiguration()
protected MetaModelValidator	getMetaModelValidator()
protected ProgrammingModel	getProgrammingModelFacets()
RuntimeContext	getRuntimeContext() As per setRuntimeContext(RuntimeContext).
List<Class<?>>	getServiceClasses()
protected SpecificationTraverser	getSpecificationTraverser()
void	init() Initializes and wires up, and primes the cache based on any service classes that may have been injected.
ValidationFailures	initAndValidate() For benefit of IsisMetaModel.
void	injectInto(Object candidate) Injects self into candidate if required, and instructs its subcomponents to do so also.
ObjectSpecification	introspectIfRequired(ObjectSpecification spec) Typically does not need to be called, but is available for FacetFactorys to force early introspection of referenced specs in certain circumstances.
void	invalidateCache(Class<?> cls)
void	invalidateCacheFor(Object domainObject)
boolean	isInitialized()
boolean	loaded(Class<?> cls) Whether this class has been loaded.
boolean	loaded(String fullyQualifiedClassName)
ObjectSpecification	loadSpecification(Class<?> type) API: Return specification.
ObjectSpecification	loadSpecification(String className) API: Return the specification for the specified class of object.
boolean	loadSpecifications(List<Class<?>> typesToLoad) Loads the specifications of the specified types.
boolean	loadSpecifications(List<Class<?>> typesToLoad, Class<?> typeToIgnore) Loads the specifications of the specified types except the one specified (to prevent an infinite loop).
ObjectSpecification	lookupBySpecId(ObjectSpecId objectSpecId)
void	setContainer(org.apache.isis.applib.DomainObjectContainer container) Specify the DomainObjectContainer as part of initializing the services.
void	setRuntimeContext(RuntimeContext runtimeContext) Due to RuntimeContextAware.
void	setServices(List<Object> services) Specify the services to pro-actively prime the cache, and to initialize them also.
void	shutdown() Indicates to the component that it will no longer be used and should shut itself down cleanly.
void	validateSpecifications(ValidationFailures validationFailures) Populated as a result of running validation after all specs have been loaded.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectReflectorDefault

public ObjectReflectorDefault(IsisConfiguration configuration,
                      ClassSubstitutor classSubstitutor,
                      CollectionTypeRegistry collectionTypeRegistry,
                      SpecificationTraverser specificationTraverser,
                      ProgrammingModel programmingModel,
                      Set<FacetDecorator> facetDecorators,
                      MetaModelValidator metaModelValidator)

Method Detail

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

init

public void init()

Initializes and wires up, and primes the cache based on any service classes that may have been injected.

Specified by:

init in interface ApplicationScopedComponent

isInitialized

public boolean isInitialized()

Specified by:

isInitialized in interface SpecificationLoaderSpi

initAndValidate

public ValidationFailures initAndValidate()

For benefit of IsisMetaModel.

shutdown

public void shutdown()

Description copied from interface: ApplicationScopedComponent

Indicates to the component that it will no longer be used and should shut itself down cleanly.

Specified by:

shutdown in interface ApplicationScopedComponent

invalidateCacheFor

public void invalidateCacheFor(Object domainObject)

Specified by:

invalidateCacheFor in interface SpecificationLoaderSpi

invalidateCache

public void invalidateCache(Class<?> cls)

Specified by:

invalidateCache in interface SpecificationLoader

Specified by:

invalidateCache in interface SpecificationLoaderSpi

loadSpecification

public final ObjectSpecification loadSpecification(String className)

API: Return the specification for the specified class of object.

Specified by:

loadSpecification in interface SpecificationLoader

loadSpecification

public ObjectSpecification loadSpecification(Class<?> type)

API: Return specification.

Specified by:

loadSpecification in interface SpecificationLoader

See Also:

SpecificationLoader.loadSpecification(String)

loadSpecifications

public boolean loadSpecifications(List<Class<?>> typesToLoad,
                         Class<?> typeToIgnore)

Loads the specifications of the specified types except the one specified (to prevent an infinite loop).

Specified by:

loadSpecifications in interface SpecificationLoader

loadSpecifications

public boolean loadSpecifications(List<Class<?>> typesToLoad)

Loads the specifications of the specified types.

Specified by:

loadSpecifications in interface SpecificationLoader

allSpecifications

public Collection<ObjectSpecification> allSpecifications()

Return all the loaded specifications.

Specified by:

allSpecifications in interface SpecificationLoader

loaded

public boolean loaded(Class<?> cls)

Description copied from interface: SpecificationLoader

Whether this class has been loaded.

Specified by:

loaded in interface SpecificationLoader

loaded

public boolean loaded(String fullyQualifiedClassName)

Specified by:

loaded in interface SpecificationLoader

See Also:

SpecificationLoader.loaded(Class).

introspectIfRequired

public ObjectSpecification introspectIfRequired(ObjectSpecification spec)

Description copied from interface: SpecificationLoader

Typically does not need to be called, but is available for FacetFactorys to force early introspection of referenced specs in certain circumstances.

Originally introduced to support AutoCompleteFacet.

Specified by:

introspectIfRequired in interface SpecificationLoader

lookupBySpecId

public ObjectSpecification lookupBySpecId(ObjectSpecId objectSpecId)

Specified by:

lookupBySpecId in interface SpecificationLoader

injectInto

public void injectInto(Object candidate)

Injects self into candidate if required, and instructs its subcomponents to do so also.

Specified by:

injectInto in interface Injectable

debugData

public void debugData(DebugBuilder debug)

Description copied from interface: Debuggable

Debug details describing the object being investigated

Specified by:

debugData in interface Debuggable

debugTitle

public String debugTitle()

Description copied from interface: DebuggableWithTitle

The title for the debug information

Specified by:

debugTitle in interface DebuggableWithTitle

getFacetProcessor

public FacetProcessor getFacetProcessor()

Provides access to the registered Facets.

getRuntimeContext

public RuntimeContext getRuntimeContext()

As per setRuntimeContext(RuntimeContext).

setRuntimeContext

public void setRuntimeContext(RuntimeContext runtimeContext)

Due to RuntimeContextAware.

Specified by:

setRuntimeContext in interface RuntimeContextAware

getServiceClasses

public List<Class<?>> getServiceClasses()

Specified by:

getServiceClasses in interface SpecificationLoader

setContainer

public void setContainer(org.apache.isis.applib.DomainObjectContainer container)

Description copied from interface: SpecificationLoaderSpi

Specify the DomainObjectContainer as part of initializing the services.

Specified by:

setContainer in interface SpecificationLoaderSpi

See Also:

SpecificationLoaderSpi.setServices(List)

setServices

public void setServices(List<Object> services)

Description copied from interface: SpecificationLoaderSpi

Specify the services to pro-actively prime the cache, and to initialize them also.

Specified by:

setServices in interface SpecificationLoaderSpi

See Also:

SpecificationLoaderSpi.setContainer(DomainObjectContainer)

getIsisConfiguration

protected IsisConfiguration getIsisConfiguration()

getCollectionTypeRegistry

protected CollectionTypeRegistry getCollectionTypeRegistry()

getClassSubstitutor

protected ClassSubstitutor getClassSubstitutor()

getSpecificationTraverser

protected SpecificationTraverser getSpecificationTraverser()

getProgrammingModelFacets

protected ProgrammingModel getProgrammingModelFacets()

getMetaModelValidator

protected MetaModelValidator getMetaModelValidator()

getFacetDecoratorSet

protected Set<FacetDecorator> getFacetDecoratorSet()

validateSpecifications

public void validateSpecifications(ValidationFailures validationFailures)

Description copied from interface: SpecificationLoaderSpi

Populated as a result of running validation after all specs have been loaded.

Specified by:

validateSpecifications in interface SpecificationLoaderSpi