org.apache.isis.core.metamodel.specloader.specimpl

Class ObjectMemberAbstract

java.lang.Object

org.apache.isis.core.metamodel.specloader.specimpl.ObjectMemberAbstract

All Implemented Interfaces:

FacetHolder, IdentifiedHolder, ObjectFeature, ObjectMember, Specification

Direct Known Subclasses:

ObjectActionImpl, ObjectAssociationAbstract

public abstract class ObjectMemberAbstract
extends Object
implements ObjectMember

Field Summary

Fields

Modifier and Type	Field and Description
protected String	defaultName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ObjectMemberAbstract(FacetedMethod facetedMethod, FeatureType featureType, ObjectMemberContext objectMemberContext)

Method Summary

Methods

Modifier and Type	Method and Description
void	addFacet(Facet facet) Adds the facet, extracting its type as the key.
void	addFacet(MultiTypedFacet facet) Adds the multi-typed facet, extracting each of its types as keys.
boolean	containsDoOpFacet(Class<? extends Facet> facetType) Whether there is a facet registered of the specified type that is not a no-op.
boolean	containsFacet(Class<? extends Facet> facetType) Whether there is a facet registered of the specified type.
AdapterManager	getAdapterManager()
protected AuthenticationSession	getAuthenticationSession() The current AuthenticationSession (can change over time so do not cache).
AuthenticationSessionProvider	getAuthenticationSessionProvider()
CollectionTypeRegistry	getCollectionTypeRegistry()
DeploymentCategory	getDeploymentCategory()
String	getDescription() Returns a description of how the member is used - this complements the help text.
<T extends Facet> T	getFacet(Class<T> cls) Get the facet of the specified type (as per the type it reports from Facet.facetType()).
FacetedMethod	getFacetedMethod()
List<Facet>	getFacets(org.apache.isis.applib.filter.Filter<Facet> filter) Returns all Facets matching the specified FacetFilter.
Class<? extends Facet>[]	getFacetTypes() Get the list of all facet types that are supported by objects of this specification.
FeatureType	getFeatureType()
String	getHelp() Return the help text for this member - the field or action - to complement the description.
String	getId() Returns the identifier of the member, which must not change.
org.apache.isis.applib.Identifier	getIdentifier() Identifier of this feature.
String	getName() Return the default label for this member.
QuerySubmitter	getQuerySubmitter()
ServicesProvider	getServicesProvider()
static ObjectSpecification	getSpecification(SpecificationLoader specificationLookup, Class<?> type)
SpecificationLoader	getSpecificationLookup()
boolean	isAction() Whether this member represents a ObjectAction.
boolean	isAlwaysHidden() When the member is always hidden.
boolean	isOneToManyAssociation() Whether this member represents a OneToManyAssociation.
boolean	isOneToOneAssociation() Whether this member represents a OneToOneAssociation.
boolean	isPropertyOrCollection() Whether this member represents a ObjectAssociation.
Consent	isUsable(AuthenticationSession session, ObjectAdapter target, org.apache.isis.applib.annotation.Where where) Loops over all DisablingInteractionAdvisor Facets and returns true only if none disables the member.
Consent	isVisible(AuthenticationSession session, ObjectAdapter target, org.apache.isis.applib.annotation.Where where) Loops over all HidingInteractionAdvisor Facets and returns true only if none hide the member.
void	removeFacet(Class<? extends Facet> facetType) Remove the facet of the specified type.
void	removeFacet(Facet facet) Remove the facet whose type is that reported by Facet.facetType() .
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.isis.core.metamodel.spec.feature.ObjectMember

createUsableInteractionContext, createVisibleInteractionContext, debugData

Methods inherited from interface org.apache.isis.core.metamodel.spec.feature.ObjectFeature

getSpecification

Methods inherited from interface org.apache.isis.core.metamodel.spec.Specification

getInstance

Field Detail

defaultName

protected final String defaultName

Constructor Detail

ObjectMemberAbstract

protected ObjectMemberAbstract(FacetedMethod facetedMethod,
                    FeatureType featureType,
                    ObjectMemberContext objectMemberContext)

Method Detail

getSpecification

public static ObjectSpecification getSpecification(SpecificationLoader specificationLookup,
                                   Class<?> type)

getDeploymentCategory

public DeploymentCategory getDeploymentCategory()

getId

public String getId()

Description copied from interface: ObjectFeature

Returns the identifier of the member, which must not change. This should be all camel-case with no spaces: so if the member is called 'Return Date' then a suitable id would be 'returnDate'.

Specified by:

getId in interface ObjectFeature

getFacetedMethod

public FacetedMethod getFacetedMethod()

Returns:

the facetedMethod

getIdentifier

public org.apache.isis.applib.Identifier getIdentifier()

Description copied from interface: IdentifiedHolder

Identifier of this feature.

Specified by:

getIdentifier in interface IdentifiedHolder

getFeatureType

public FeatureType getFeatureType()

Specified by:

getFeatureType in interface Specification

containsFacet

public boolean containsFacet(Class<? extends Facet> facetType)

Description copied from interface: FacetHolder

Whether there is a facet registered of the specified type.

Specified by:

containsFacet in interface FacetHolder

containsDoOpFacet

public boolean containsDoOpFacet(Class<? extends Facet> facetType)

Description copied from interface: FacetHolder

Whether there is a facet registered of the specified type that is not a no-op.

Convenience; saves having to FacetHolder.getFacet(Class) and then check if null and not a no-op.

Specified by:

containsDoOpFacet in interface FacetHolder

getFacet

public <T extends Facet> T getFacet(Class<T> cls)

Description copied from interface: FacetHolder

Get the facet of the specified type (as per the type it reports from Facet.facetType()).

Specified by:

getFacet in interface FacetHolder

getFacetTypes

public Class<? extends Facet>[] getFacetTypes()

Description copied from interface: FacetHolder

Get the list of all facet types that are supported by objects of this specification.

Specified by:

getFacetTypes in interface FacetHolder

getFacets

public List<Facet> getFacets(org.apache.isis.applib.filter.Filter<Facet> filter)

Description copied from interface: FacetHolder

Returns all Facets matching the specified FacetFilter.

Specified by:

getFacets in interface FacetHolder

Returns:

addFacet

public void addFacet(Facet facet)

Description copied from interface: FacetHolder

Adds the facet, extracting its type as the key.

If there are any facet of the same type, they will be overwritten provided that either the Facet specifies to always replace or if the existing Facet is a no-op.

Specified by:

addFacet in interface FacetHolder

addFacet

public void addFacet(MultiTypedFacet facet)

Description copied from interface: FacetHolder

Adds the multi-typed facet, extracting each of its types as keys.

If there are any facet of the same type, they will be overwritten provided that either the Facet specifies to always replace or if the existing Facet is a no-op.

Specified by:

addFacet in interface FacetHolder

removeFacet

public void removeFacet(Facet facet)

Description copied from interface: FacetHolder

Remove the facet whose type is that reported by Facet.facetType() .

Specified by:

removeFacet in interface FacetHolder

removeFacet

public void removeFacet(Class<? extends Facet> facetType)

Description copied from interface: FacetHolder

Remove the facet of the specified type.

Specified by:

removeFacet in interface FacetHolder

getName

public String getName()

Return the default label for this member. This is based on the name of this member.

Specified by:

getName in interface ObjectFeature

See Also:

getId()

getDescription

public String getDescription()

Description copied from interface: ObjectFeature

Returns a description of how the member is used - this complements the help text.

Specified by:

getDescription in interface ObjectFeature

Specified by:

getDescription in interface Specification

See Also:

#getHelp()

getHelp

public String getHelp()

Description copied from interface: ObjectMember

Return the help text for this member - the field or action - to complement the description.

Specified by:

getHelp in interface ObjectMember

See Also:

ObjectFeature.getDescription()

isAlwaysHidden

public boolean isAlwaysHidden()

Description copied from interface: ObjectMember

When the member is always hidden.

Determined as per the HiddenFacet being present and WhenValueFacet.when() returning When.ALWAYS, and WhenAndWhereValueFacet.where() returning When#ANYWHERE.

Specified by:

isAlwaysHidden in interface ObjectMember

isVisible

public Consent isVisible(AuthenticationSession session,
                ObjectAdapter target,
                org.apache.isis.applib.annotation.Where where)

Loops over all HidingInteractionAdvisor Facets and returns true only if none hide the member.

TODO: currently this method is hard-coded to assume all interactions are initiated by user.

Specified by:

isVisible in interface ObjectMember

target - may be null if just checking for authorization.

where - the member is being rendered in the UI

See Also:

#isVisibleResult(AuthenticationSession, ObjectAdapter)

isUsable

public Consent isUsable(AuthenticationSession session,
               ObjectAdapter target,
               org.apache.isis.applib.annotation.Where where)

Loops over all DisablingInteractionAdvisor Facets and returns true only if none disables the member.

TODO: currently this method is hard-coded to assume all interactions are initiated by user.

Specified by:

isUsable in interface ObjectMember

target - may be null if just checking for authorization.

where - the member is being rendered in the UI

See Also:

#isUsableResult(AuthenticationSession, ObjectAdapter)

isAction

public boolean isAction()

Description copied from interface: ObjectMember

Whether this member represents a ObjectAction.

If so, can be safely downcast to ObjectAction.

Specified by:

isAction in interface ObjectMember

isPropertyOrCollection

public boolean isPropertyOrCollection()

Description copied from interface: ObjectMember

Whether this member represents a ObjectAssociation.

If so, can be safely downcast to ObjectAssociation.

Specified by:

isPropertyOrCollection in interface ObjectMember

isOneToManyAssociation

public boolean isOneToManyAssociation()

Description copied from interface: ObjectMember

Whether this member represents a OneToManyAssociation.

If so, can be safely downcast to OneToManyAssociation.

Specified by:

isOneToManyAssociation in interface ObjectMember

isOneToOneAssociation

public boolean isOneToOneAssociation()

Description copied from interface: ObjectMember

Whether this member represents a OneToOneAssociation.

If so, can be safely downcast to OneToOneAssociation.

Specified by:

isOneToOneAssociation in interface ObjectMember

getAuthenticationSession

protected AuthenticationSession getAuthenticationSession()

The current AuthenticationSession (can change over time so do not cache).

toString

public String toString()

Overrides:

toString in class Object

getAuthenticationSessionProvider

public AuthenticationSessionProvider getAuthenticationSessionProvider()

getSpecificationLookup

public SpecificationLoader getSpecificationLookup()

getAdapterManager

public AdapterManager getAdapterManager()

getServicesProvider

public ServicesProvider getServicesProvider()

getQuerySubmitter

public QuerySubmitter getQuerySubmitter()

getCollectionTypeRegistry

public CollectionTypeRegistry getCollectionTypeRegistry()