001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 */
019
020package org.apache.isis.core.progmodel.facets.members.order;
021
022import java.util.Properties;
023
024import org.apache.isis.applib.annotation.MemberOrder;
025import org.apache.isis.core.metamodel.facetapi.FacetHolder;
026import org.apache.isis.core.metamodel.facetapi.FacetUtil;
027import org.apache.isis.core.metamodel.facetapi.FeatureType;
028import org.apache.isis.core.metamodel.facets.Annotations;
029import org.apache.isis.core.metamodel.facets.ContributeeMemberFacetFactory;
030import org.apache.isis.core.metamodel.facets.FacetFactoryAbstract;
031import org.apache.isis.core.metamodel.facets.members.order.MemberOrderFacet;
032
033public class MemberOrderFacetFactory extends FacetFactoryAbstract implements ContributeeMemberFacetFactory {
034
035    public MemberOrderFacetFactory() {
036        super(FeatureType.MEMBERS);
037    }
038
039    @Override
040    public void process(final ProcessMethodContext processMethodContext) {
041        
042        MemberOrderFacet memberOrderFacet = createFromMetadataPropertiesIfPossible(processMethodContext);
043        if(memberOrderFacet == null) {
044            memberOrderFacet = createFromAnnotationIfPossible(processMethodContext);
045        }
046
047        // no-op if facet is null
048        FacetUtil.addFacet(memberOrderFacet);
049    }
050
051    @Override
052    public void process(final ProcessContributeeMemberContext processMemberContext) {
053        final MemberOrderFacet memberOrderFacet = createFromMetadataPropertiesIfPossible(processMemberContext);
054
055        // no-op if facet is null
056        FacetUtil.addFacet(memberOrderFacet);
057    }
058
059    private static MemberOrderFacet createFromMetadataPropertiesIfPossible(
060            final ProcessContextWithMetadataProperties<? extends FacetHolder> pcwmp) {
061        
062        final FacetHolder holder = pcwmp.getFacetHolder();
063        
064        final MemberOrderFacet memberOrderFacet;
065        final Properties properties = pcwmp.metadataProperties("memberOrder");
066        if(properties != null) {
067            memberOrderFacet = new MemberOrderFacetProperties(properties, holder);
068        } else {
069            memberOrderFacet = null;
070        }
071        return memberOrderFacet;
072    }
073
074    private static MemberOrderFacet createFromAnnotationIfPossible(final ProcessMethodContext processMethodContext) {
075        final MemberOrder annotation = Annotations.getAnnotation(processMethodContext.getMethod(), MemberOrder.class);
076        return annotation != null ? new MemberOrderFacetAnnotation(annotation.name(), annotation.sequence(), processMethodContext.getFacetHolder()) : null;
077    }
078
079
080}