/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.isis.viewer.restfulobjects.rendering.domainobjects;
import java.util.List;
import java.util.Map;
import com.fasterxml.jackson.databind.node.NullNode;
import com.google.common.collect.Lists;
import org.apache.isis.applib.annotation.Render.Type;
import org.apache.isis.applib.annotation.Where;
import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
import org.apache.isis.core.metamodel.facetapi.Facet;
import org.apache.isis.core.metamodel.facetapi.FacetHolder;
import org.apache.isis.core.metamodel.facets.members.render.RenderFacet;
import org.apache.isis.core.metamodel.facets.object.title.TitleFacet;
import org.apache.isis.core.metamodel.facets.object.value.ValueFacet;
import org.apache.isis.core.metamodel.facets.value.bigdecimal.BigDecimalValueFacet;
import org.apache.isis.core.metamodel.facets.value.biginteger.BigIntegerValueFacet;
import org.apache.isis.core.metamodel.spec.ObjectSpecification;
import org.apache.isis.core.metamodel.spec.feature.OneToOneAssociation;
import org.apache.isis.viewer.restfulobjects.applib.JsonRepresentation;
import org.apache.isis.viewer.restfulobjects.applib.Rel;
import org.apache.isis.viewer.restfulobjects.applib.RepresentationType;
import org.apache.isis.viewer.restfulobjects.rendering.LinkBuilder;
import org.apache.isis.viewer.restfulobjects.rendering.LinkFollowSpecs;
import org.apache.isis.viewer.restfulobjects.rendering.RendererContext;
import org.apache.isis.viewer.restfulobjects.rendering.domaintypes.PropertyDescriptionReprRenderer;
public class ObjectPropertyReprRenderer extends AbstractObjectMemberReprRenderer<ObjectPropertyReprRenderer, OneToOneAssociation> {
public ObjectPropertyReprRenderer(
final RendererContext resourceContext) {
this(resourceContext, null, null, JsonRepresentation.newMap());
}
public ObjectPropertyReprRenderer(
final RendererContext resourceContext,
final LinkFollowSpecs linkFollower,
final String propertyId,
final JsonRepresentation representation) {
super(resourceContext, linkFollower, propertyId, RepresentationType.OBJECT_PROPERTY, representation,
Where.OBJECT_FORMS);
}
@Override
public JsonRepresentation render() {
renderMemberContent();
final LinkFollowSpecs followValue = getLinkFollowSpecs().follow("value");
addValue(followValue);
putDisabledReasonIfDisabled();
if (mode.isStandalone() || mode.isMutated()) {
addChoices();
addExtensionsIsisProprietaryChangedObjects();
}
return representation;
}
// ///////////////////////////////////////////////////
// value
// ///////////////////////////////////////////////////
private Object addValue(final LinkFollowSpecs linkFollower) {
final ObjectAdapter valueAdapter = objectMember.get(objectAdapter, getInteractionInitiatedBy());
// use the runtime type if we have a value, else the compile time type of the member otherwise
final ObjectSpecification spec = valueAdapter != null? valueAdapter.getSpecification(): objectMember.getSpecification();
final ValueFacet valueFacet = spec.getFacet(ValueFacet.class);
if (valueFacet != null) {
String format = null;
final Class<?> specClass = spec.getCorrespondingClass();
if(specClass == java.math.BigDecimal.class) {
// look for facet on member, else on the value's spec
final BigDecimalValueFacet bigDecimalValueFacet =
getFacet(BigDecimalValueFacet.class,
objectMember,
valueAdapter != null? valueAdapter.getSpecification(): null);
if(bigDecimalValueFacet != null) {
final Integer precision = bigDecimalValueFacet.getPrecision();
final Integer scale = bigDecimalValueFacet.getScale();
format = String.format("big-decimal(%d,%d)", precision, scale);
}
} else if(specClass == java.math.BigInteger.class) {
// look for facet on member, else on the value's spec
final BigIntegerValueFacet bigIntegerValueFacet =
getFacet(BigIntegerValueFacet.class,
objectMember,
valueAdapter != null? valueAdapter.getSpecification(): null);
if(bigIntegerValueFacet != null) {
format = String.format("big-integer");
}
}
return JsonValueEncoder.appendValueAndFormat(spec, valueAdapter, representation, format, rendererContext.suppressMemberExtensions());
}
final RenderFacet renderFacet = objectMember.getFacet(RenderFacet.class);
boolean eagerlyRender =
(renderFacet != null && renderFacet.value() == Type.EAGERLY && rendererContext.canEagerlyRender(valueAdapter))
|| (linkFollower != null && !linkFollower.isTerminated());
if(valueAdapter == null) {
final NullNode value = NullNode.getInstance();
representation.mapPut("value", value);
return value;
} else {
final TitleFacet titleFacet = spec.getFacet(TitleFacet.class);
final String title = titleFacet.title(valueAdapter);
final LinkBuilder valueLinkBuilder = DomainObjectReprRenderer.newLinkToBuilder(rendererContext, Rel.VALUE, valueAdapter).withTitle(title);
if(eagerlyRender) {
final DomainObjectReprRenderer renderer = new DomainObjectReprRenderer(rendererContext, linkFollower, JsonRepresentation.newMap()
);
renderer.with(valueAdapter);
if(mode.isEventSerialization()) {
renderer.asEventSerialization();
}
valueLinkBuilder.withValue(renderer.render());
}
final JsonRepresentation valueJsonRepr = valueLinkBuilder.build();
representation.mapPut("value", valueJsonRepr);
return valueJsonRepr;
}
}
private static <T extends Facet> T getFacet(Class<T> facetType, FacetHolder... holders) {
for (FacetHolder holder : holders) {
if(holder == null) {
continue;
}
final T facet = holder.getFacet(facetType);
if(facet != null) {
return facet;
}
}
return null;
}
// ///////////////////////////////////////////////////
// details link
// ///////////////////////////////////////////////////
/**
* Mandatory hook method to support x-ro-follow-links
*/
@Override
protected void followDetailsLink(final JsonRepresentation detailsLink) {
final JsonRepresentation representation = JsonRepresentation.newMap();
final ObjectPropertyReprRenderer renderer = new ObjectPropertyReprRenderer(getRendererContext(), getLinkFollowSpecs(), null, representation);
renderer.with(new ObjectAndProperty(objectAdapter, objectMember)).asFollowed();
detailsLink.mapPut("value", renderer.render());
}
// ///////////////////////////////////////////////////
// mutators
// ///////////////////////////////////////////////////
@Override
protected void addMutatorLinksIfEnabled() {
if (usability().isVetoed()) {
return;
}
final Map<String, MutatorSpec> mutators = objectMemberType.getMutators();
for (final String mutator : mutators.keySet()) {
final MutatorSpec mutatorSpec = mutators.get(mutator);
addLinkFor(mutatorSpec);
}
return;
}
// ///////////////////////////////////////////////////
// choices
// ///////////////////////////////////////////////////
private ObjectPropertyReprRenderer addChoices() {
final Object propertyChoices = propertyChoices();
if (propertyChoices != null) {
representation.mapPut("choices", propertyChoices);
}
return this;
}
private Object propertyChoices() {
final ObjectAdapter[] choiceAdapters =
objectMember.getChoices(
objectAdapter,
getInteractionInitiatedBy());
if (choiceAdapters == null || choiceAdapters.length == 0) {
return null;
}
final List<Object> list = Lists.newArrayList();
for (final ObjectAdapter choiceAdapter : choiceAdapters) {
// REVIEW: previously was using the spec of the member, but think instead it should be the spec of the adapter itself
// final ObjectSpecification choiceSpec = objectMember.getSpecification();
// REVIEW: check that it works for ToDoItem$Category, though...
final ObjectSpecification choiceSpec = choiceAdapter.getSpecification();
list.add(DomainObjectReprRenderer.valueOrRef(rendererContext, choiceAdapter, choiceSpec));
}
return list;
}
// ///////////////////////////////////////////////////
// extensions and links
// ///////////////////////////////////////////////////
@Override
protected void addLinksToFormalDomainModel() {
if(rendererContext.suppressDescribedByLinks()) {
return;
}
final JsonRepresentation link = PropertyDescriptionReprRenderer.newLinkToBuilder(getRendererContext(), Rel.DESCRIBEDBY, objectAdapter.getSpecification(), objectMember).build();
getLinks().arrayAdd(link);
}
@Override
protected void addLinksIsisProprietary() {
// none
}
@Override
protected void putExtensionsIsisProprietary() {
// none
}
}