001/**
002 *  Licensed to the Apache Software Foundation (ASF) under one or more
003 *  contributor license agreements.  See the NOTICE file distributed with
004 *  this work for additional information regarding copyright ownership.
005 *  The ASF licenses this file to You under the Apache License, Version 2.0
006 *  (the "License"); you may not use this file except in compliance with
007 *  the License.  You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 *  Unless required by applicable law or agreed to in writing, software
012 *  distributed under the License is distributed on an "AS IS" BASIS,
013 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 *  See the License for the specific language governing permissions and
015 *  limitations under the License.
016 */
017package org.apache.isis.viewer.restfulobjects.rendering.domaintypes;
018
019import org.apache.isis.core.metamodel.facets.maxlen.MaxLengthFacet;
020import org.apache.isis.core.metamodel.spec.ObjectSpecification;
021import org.apache.isis.core.metamodel.spec.feature.ObjectAction;
022import org.apache.isis.core.metamodel.spec.feature.ObjectActionParameter;
023import org.apache.isis.viewer.restfulobjects.applib.JsonRepresentation;
024import org.apache.isis.viewer.restfulobjects.applib.Rel;
025import org.apache.isis.viewer.restfulobjects.applib.RepresentationType;
026import org.apache.isis.viewer.restfulobjects.rendering.LinkBuilder;
027import org.apache.isis.viewer.restfulobjects.rendering.LinkFollowSpecs;
028import org.apache.isis.viewer.restfulobjects.rendering.RendererContext;
029
030public class ActionParameterDescriptionReprRenderer extends AbstractTypeFeatureReprRenderer<ActionParameterDescriptionReprRenderer, ObjectActionParameter> {
031
032    public static LinkBuilder newLinkToBuilder(final RendererContext resourceContext, final Rel rel, final ObjectSpecification objectSpecification, final ObjectActionParameter objectActionParameter) {
033        final String domainType = objectSpecification.getSpecId().asString();
034        final ObjectAction objectAction = objectActionParameter.getAction();
035        final String actionId = objectAction.getId();
036        final String paramName = objectActionParameter.getName();
037        final String url = String.format("domain-types/%s/actions/%s/params/%s", domainType, actionId, paramName);
038        return LinkBuilder.newBuilder(resourceContext, rel.andParam("id", deriveId(objectActionParameter)), RepresentationType.ACTION_PARAMETER_DESCRIPTION, url);
039    }
040
041    public ActionParameterDescriptionReprRenderer(final RendererContext resourceContext, final LinkFollowSpecs linkFollower, final JsonRepresentation representation) {
042        super(resourceContext, linkFollower, RepresentationType.ACTION_PARAMETER_DESCRIPTION, representation);
043    }
044
045    @Override
046    public ActionParameterDescriptionReprRenderer with(final ParentSpecAndFeature<ObjectActionParameter> specAndFeature) {
047        super.with(specAndFeature);
048
049        // done eagerly so can use as criteria for x-ro-follow-links
050        representation.mapPut("id", deriveId());
051
052        return this;
053    }
054
055    protected String deriveId() {
056        return deriveId(getObjectFeature());
057    }
058
059    private static String deriveId(final ObjectActionParameter objectActionParameter) {
060        return objectActionParameter.getAction().getId() + "-" + objectActionParameter.getName();
061    }
062
063    @Override
064    protected void addLinkSelfIfRequired() {
065        if (!includesSelf) {
066            return;
067        }
068        getLinks().arrayAdd(newLinkToBuilder(getRendererContext(), Rel.SELF, getParentSpecification(), getObjectFeature()).build());
069    }
070
071    @Override
072    protected void addLinkUpToParent() {
073        final ObjectAction parentAction = this.objectFeature.getAction();
074
075        final LinkBuilder parentLinkBuilder = ActionDescriptionReprRenderer.newLinkToBuilder(rendererContext, Rel.UP, objectSpecification, parentAction);
076        getLinks().arrayAdd(parentLinkBuilder.build());
077    }
078
079    @Override
080    protected void addPropertiesSpecificToFeature() {
081        representation.mapPut("name", getObjectFeature().getName());
082        representation.mapPut("number", getObjectFeature().getNumber());
083        representation.mapPut("optional", getObjectFeature().isOptional());
084        final MaxLengthFacet maxLength = getObjectFeature().getFacet(MaxLengthFacet.class);
085        if (maxLength != null && !maxLength.isNoop()) {
086            representation.mapPut("maxLength", maxLength.value());
087        }
088    }
089
090    @Override
091    protected void addLinksSpecificToFeature() {
092        final LinkBuilder linkBuilder = DomainTypeReprRenderer.newLinkToBuilder(rendererContext, Rel.RETURN_TYPE, objectFeature.getSpecification());
093        getLinks().arrayAdd(linkBuilder.build());
094    }
095
096    @Override
097    protected void putExtensionsSpecificToFeature() {
098        putExtensionsName();
099        putExtensionsDescriptionIfAvailable();
100    }
101
102}