org.apache.isis.viewer.restfulobjects.rendering.domainobjects

Class AbstractObjectMemberReprRenderer<R extends ReprRendererAbstract<R,ObjectAndMember<T>>,T extends org.apache.isis.core.metamodel.spec.feature.ObjectMember>

java.lang.Object

org.apache.isis.viewer.restfulobjects.rendering.ReprRendererAbstract<R,ObjectAndMember<T>>

org.apache.isis.viewer.restfulobjects.rendering.domainobjects.AbstractObjectMemberReprRenderer<R,T>

All Implemented Interfaces:

ReprRenderer<R,ObjectAndMember<T>>

Direct Known Subclasses:

ObjectActionReprRenderer, ObjectCollectionReprRenderer, ObjectPropertyReprRenderer

public abstract class AbstractObjectMemberReprRenderer<R extends ReprRendererAbstract<R,ObjectAndMember<T>>,T extends org.apache.isis.core.metamodel.spec.feature.ObjectMember>
extends ReprRendererAbstract<R,ObjectAndMember<T>>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractObjectMemberReprRenderer.Mode

Field Summary

Fields

Modifier and Type	Field and Description
protected ObjectAdapterLinkTo	linkTo
protected AbstractObjectMemberReprRenderer.Mode	mode
protected org.apache.isis.core.metamodel.spec.ManagedObject	objectAdapter
protected T	objectMember
protected MemberType	objectMemberType Derived from objectMember using MemberType.determineFrom(ObjectFeature)

Fields inherited from class org.apache.isis.viewer.restfulobjects.rendering.ReprRendererAbstract

includesSelf, jsonValueEncoder, representation, resourceContext

Constructor Summary

Constructors

Constructor and Description
AbstractObjectMemberReprRenderer(IResourceContext resourceContext, LinkFollowSpecs linkFollower, String memberId, org.apache.isis.viewer.restfulobjects.applib.RepresentationType representationType, org.apache.isis.viewer.restfulobjects.applib.JsonRepresentation representation, org.apache.isis.applib.annotation.Where where)

Method Summary

Modifier and Type	Method and Description
protected void	addLinkFor(MutatorSpec mutatorSpec) For subclasses to call back to when adding mutators.
protected abstract void	addLinksIsisProprietary()
protected abstract void	addLinksToFormalDomainModel()
protected abstract void	addMutatorLinksIfEnabled()
R	asArguments()
R	asEventSerialization()
R	asFollowed() Indicate that this is a representation to include as the result of a followed link.
R	asMutated() Indicates that the representation was produced as the result of a resource that mutated the state.
R	asStandalone() Indicate that this is a standalone representation.
protected abstract void	followDetailsLink(org.apache.isis.viewer.restfulobjects.applib.JsonRepresentation detailsLink)
protected String	getMemberId()
protected <F extends org.apache.isis.core.metamodel.facetapi.Facet> F	getMemberSpecFacet(Class<F> facetType) Convenience method.
protected boolean	hasMemberFacet(Class<? extends org.apache.isis.core.metamodel.facetapi.Facet> facetType)
boolean	isMemberVisible() Convenience method.
protected ObjectAdapterLinkTo	linkToForMutatorInvoke() Hook to allow actions to render invoke links that point to the contributing service.
protected org.apache.isis.viewer.restfulobjects.applib.JsonRepresentation	mutatorArgs(MutatorSpec mutatorSpec) Default implementation (common to properties and collections) that can be overridden (ie by actions) if required.
protected void	putDisabledReasonIfDisabled()
protected abstract void	putExtensionsIsisProprietary()
protected void	renderMemberContent() For subclasses to call from their ReprRendererAbstract.render() method.
protected org.apache.isis.core.metamodel.consent.Consent	usability()
R	usingLinkTo(ObjectAdapterLinkTo linkTo) Must be called after with(ObjectAndMember) (which provides the objectAdapter).
protected org.apache.isis.core.metamodel.consent.Consent	visibility()
R	with(ObjectAndMember<T> objectAndMember)
void	withMemberMode(MemberReprMode memberMode)

Methods inherited from class org.apache.isis.viewer.restfulobjects.rendering.ReprRendererAbstract

addExtensionsIsisProprietaryChangedObjects, addLink, addMediaTypeParams, cast, getExtensions, getInteractionInitiatedBy, getJsonValueEncoder, getLinkFollowSpecs, getLinks, getMediaType, getResourceContext, includesSelf, render, streamServiceAdapters, withExtensions, withLink, withLink

Methods inherited from class java.lang.Object

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

Field Detail

linkTo

protected ObjectAdapterLinkTo linkTo

objectAdapter

protected org.apache.isis.core.metamodel.spec.ManagedObject objectAdapter

mode

protected AbstractObjectMemberReprRenderer.Mode mode

objectMemberType

protected MemberType objectMemberType

Derived from objectMember using MemberType.determineFrom(ObjectFeature)

objectMember

protected T extends org.apache.isis.core.metamodel.spec.feature.ObjectMember objectMember

Constructor Detail

AbstractObjectMemberReprRenderer

public AbstractObjectMemberReprRenderer(IResourceContext resourceContext,
                                        LinkFollowSpecs linkFollower,
                                        String memberId,
                                        org.apache.isis.viewer.restfulobjects.applib.RepresentationType representationType,
                                        org.apache.isis.viewer.restfulobjects.applib.JsonRepresentation representation,
                                        org.apache.isis.applib.annotation.Where where)

Method Detail

getMemberId

protected String getMemberId()

with

public R with(ObjectAndMember<T> objectAndMember)

usingLinkTo

public R usingLinkTo(ObjectAdapterLinkTo linkTo)

Must be called after with(ObjectAndMember) (which provides the objectAdapter).

asStandalone

public R asStandalone()

Indicate that this is a standalone representation.

asEventSerialization

public R asEventSerialization()

asFollowed

public R asFollowed()

Indicate that this is a representation to include as the result of a followed link.

asMutated

public R asMutated()

Indicates that the representation was produced as the result of a resource that mutated the state.

The effect of this is to suppress the link to self.

asArguments

public R asArguments()

renderMemberContent

protected void renderMemberContent()

For subclasses to call from their ReprRendererAbstract.render() method.

withMemberMode

public void withMemberMode(MemberReprMode memberMode)

addMutatorLinksIfEnabled

protected abstract void addMutatorLinksIfEnabled()

addLinkFor

protected void addLinkFor(MutatorSpec mutatorSpec)

For subclasses to call back to when adding mutators.

linkToForMutatorInvoke

protected ObjectAdapterLinkTo linkToForMutatorInvoke()

Hook to allow actions to render invoke links that point to the contributing service.

mutatorArgs

protected org.apache.isis.viewer.restfulobjects.applib.JsonRepresentation mutatorArgs(MutatorSpec mutatorSpec)

Default implementation (common to properties and collections) that can be overridden (ie by actions) if required.

followDetailsLink

protected abstract void followDetailsLink(org.apache.isis.viewer.restfulobjects.applib.JsonRepresentation detailsLink)

putDisabledReasonIfDisabled

protected final void putDisabledReasonIfDisabled()

putExtensionsIsisProprietary

protected abstract void putExtensionsIsisProprietary()

addLinksToFormalDomainModel

protected abstract void addLinksToFormalDomainModel()

addLinksIsisProprietary

protected abstract void addLinksIsisProprietary()

isMemberVisible

public boolean isMemberVisible()

Convenience method.

getMemberSpecFacet

protected <F extends org.apache.isis.core.metamodel.facetapi.Facet> F getMemberSpecFacet(Class<F> facetType)

Convenience method.

hasMemberFacet

protected boolean hasMemberFacet(Class<? extends org.apache.isis.core.metamodel.facetapi.Facet> facetType)

usability

protected org.apache.isis.core.metamodel.consent.Consent usability()

visibility

protected org.apache.isis.core.metamodel.consent.Consent visibility()