org.apache.isis.core.metamodel.specloader.facetprocessor

Class FacetProcessor

java.lang.Object

org.apache.isis.core.metamodel.specloader.facetprocessor.FacetProcessor

All Implemented Interfaces:

RuntimeContextAware

public class FacetProcessor
extends Object
implements RuntimeContextAware

Constructor Summary

Constructors

Constructor and Description
FacetProcessor(IsisConfiguration configuration, CollectionTypeRegistry collectionTypeRegistry, ProgrammingModel programmingModel)

Method Summary

Methods

Modifier and Type	Method and Description
void	findAndRemoveCollectionAccessors(MethodRemover methodRemover, List<Method> methodListToAppendTo) Use the provided MethodRemover to have all known PropertyOrCollectionIdentifyingFacetFactorys to remove all property accessors, and append them to the supplied methodList.
void	findAndRemovePropertyAccessors(MethodRemover methodRemover, List<Method> methodListToAppendTo) Use the provided MethodRemover to have all known PropertyOrCollectionIdentifyingFacetFactorys to remove all property accessors, and append them to the supplied methodList.
Set<Method>	findAssociationCandidateAccessors(List<Method> methods, Set<Method> candidates) Appends to the supplied Set all of the Methods that may represent a property or collection.
FacetFactory	getFactoryByFactoryType(Class<? extends FacetFactory> factoryType)
void	init()
void	injectDependenciesInto(FacetFactory factory) This is public so that can be used for @Facets processing.
void	process(Class<?> cls, Method method, MethodRemover methodRemover, FacetedMethod facetedMethod, FeatureType featureType, Properties metadataProperties) Attaches all facets applicable to the provided type of feature to the supplied FacetHolder.
void	process(Class<?> cls, Properties metadataProperties, MethodRemover methodRemover, FacetHolder facetHolder) Attaches all facets applicable to the provided object) to the supplied FacetHolder.
void	processMemberOrder(Properties metadataProperties, ObjectMember facetHolder)
void	processParams(Method method, int paramNum, FacetedMethodParameter facetedMethodParameter) Attaches all facets applicable to the provided parameter), to the supplied FacetHolder.
void	processPost(Class<?> cls, Properties metadataProperties, MethodRemover methodRemover, FacetHolder facetHolder)
boolean	recognizes(Method method) Whether this method is recognized by any of the FacetFactorys.
void	registerFactory(FacetFactory factory)
void	setRuntimeContext(RuntimeContext runtimeContext) Injected so can propogate to any registered FacetFactory s that are also RuntimeContextAware.
void	shutdown()

Methods inherited from class java.lang.Object

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

Constructor Detail

FacetProcessor

public FacetProcessor(IsisConfiguration configuration,
              CollectionTypeRegistry collectionTypeRegistry,
              ProgrammingModel programmingModel)

Method Detail

init

public void init()

shutdown

public void shutdown()

registerFactory

public void registerFactory(FacetFactory factory)

injectDependenciesInto

public void injectDependenciesInto(FacetFactory factory)

This is public so that can be used for @Facets processing.

getFactoryByFactoryType

public FacetFactory getFactoryByFactoryType(Class<? extends FacetFactory> factoryType)

findAssociationCandidateAccessors

public Set<Method> findAssociationCandidateAccessors(List<Method> methods,
                                            Set<Method> candidates)

Appends to the supplied Set all of the Methods that may represent a property or collection.

Delegates to all known PropertyOrCollectionIdentifyingFacetFactorys.

findAndRemovePropertyAccessors

public void findAndRemovePropertyAccessors(MethodRemover methodRemover,
                                  List<Method> methodListToAppendTo)

Use the provided MethodRemover to have all known PropertyOrCollectionIdentifyingFacetFactorys to remove all property accessors, and append them to the supplied methodList.

Intended to be called after #findAndRemoveValuePropertyAccessors(MethodRemover, List) once only reference properties remain.

See Also:

PropertyOrCollectionIdentifyingFacetFactory#findAndRemoveValuePropertyAccessors(MethodRemover, List)

findAndRemoveCollectionAccessors

public void findAndRemoveCollectionAccessors(MethodRemover methodRemover,
                                    List<Method> methodListToAppendTo)

Use the provided MethodRemover to have all known PropertyOrCollectionIdentifyingFacetFactorys to remove all property accessors, and append them to the supplied methodList.

See Also:

PropertyOrCollectionIdentifyingFacetFactory.findAndRemoveCollectionAccessors(MethodRemover, List)

recognizes

public boolean recognizes(Method method)

Whether this method is recognized by any of the FacetFactorys.

Typically this is when method has a specific prefix, such as validate or hide. Specifically, it checks:

• the method's prefix against the prefixes supplied by any MethodPrefixBasedFacetFactory
• the method against any MethodFilteringFacetFactory

The design of MethodPrefixBasedFacetFactory (whereby this facet factory set does the work) is a slight performance optimization for when there are multiple facet factories that search for the same prefix.

process

public void process(Class<?> cls,
           Properties metadataProperties,
           MethodRemover methodRemover,
           FacetHolder facetHolder)

Attaches all facets applicable to the provided object) to the supplied FacetHolder.

Delegates to FacetFactory#process(Class, FacetHolder) for each appropriate factory.

Parameters:

cls - - class to process

facetHolder - - holder to attach facets to.

See Also:

FacetFactory.process(ProcessClassContext)

processPost

public void processPost(Class<?> cls,
               Properties metadataProperties,
               MethodRemover methodRemover,
               FacetHolder facetHolder)

process

public void process(Class<?> cls,
           Method method,
           MethodRemover methodRemover,
           FacetedMethod facetedMethod,
           FeatureType featureType,
           Properties metadataProperties)

Attaches all facets applicable to the provided type of feature to the supplied FacetHolder.

Delegates to FacetFactory#process(Method, FacetHolder) for each appropriate factory.

Parameters:

cls - - class in which introspect; allowing the helper methods to be found is subclasses of that which the method was originally found.

method - - method to process

facetedMethod - - holder to attach facets to.

featureType - - what type of feature the method represents (property, action, collection etc)

metadataProperties - - additional properties to parse and use

See Also:

FacetFactory#process(Method, FacetHolder)

processMemberOrder

public void processMemberOrder(Properties metadataProperties,
                      ObjectMember facetHolder)

processParams

public void processParams(Method method,
                 int paramNum,
                 FacetedMethodParameter facetedMethodParameter)

Attaches all facets applicable to the provided parameter), to the supplied FacetHolder.

Delegates to FacetFactory.processParams(ProcessParameterContext) for each appropriate factory.

Parameters:

method - - action method to process

paramNum - - 0-based

facetedMethodParameter - - holder to attach facets to.

See Also:

FacetFactory.processParams(ProcessParameterContext)

setRuntimeContext

public void setRuntimeContext(RuntimeContext runtimeContext)

Injected so can propogate to any registered FacetFactory s that are also RuntimeContextAware.

Specified by:

setRuntimeContext in interface RuntimeContextAware