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.object.title;
021
022import java.lang.reflect.Method;
023
024import org.apache.isis.core.commons.lang.ClassExtensions;
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.object.title.TitleFacet;
029import org.apache.isis.core.metamodel.methodutils.MethodScope;
030import org.apache.isis.core.progmodel.facets.MethodFinderUtils;
031import org.apache.isis.core.progmodel.facets.MethodPrefixBasedFacetFactoryAbstract;
032import org.apache.isis.core.progmodel.facets.fallback.FallbackFacetFactory;
033
034public class TitleMethodFacetFactory extends MethodPrefixBasedFacetFactoryAbstract {
035
036    private static final String TO_STRING = "toString";
037    private static final String TITLE = "title";
038
039    private static final String[] PREFIXES = { TO_STRING, TITLE, };
040
041    public TitleMethodFacetFactory() {
042        super(FeatureType.OBJECTS_ONLY, OrphanValidation.VALIDATE, PREFIXES);
043    }
044
045    /**
046     * If no title or toString can be used then will use Facets provided by
047     * {@link FallbackFacetFactory} instead.
048     */
049    @Override
050    public void process(final ProcessClassContext processClassContext) {
051        final Class<?> cls = processClassContext.getCls();
052        final FacetHolder facetHolder = processClassContext.getFacetHolder();
053
054        Method method = MethodFinderUtils.findMethod(cls, MethodScope.OBJECT, TITLE, String.class, null);
055        if (method != null) {
056            processClassContext.removeMethod(method);
057            FacetUtil.addFacet(new TitleFacetViaTitleMethod(method, facetHolder));
058            return;
059        }
060
061        // may have a facet by virtue of @Title, say.
062        final TitleFacet existingTitleFacet = facetHolder.getFacet(TitleFacet.class);
063        if(existingTitleFacet != null && !existingTitleFacet.isNoop()) {
064            return;
065        }
066
067        try {
068            method = MethodFinderUtils.findMethod(cls, MethodScope.OBJECT, TO_STRING, String.class, null);
069            if (method == null) {
070                return;
071            }
072            if (ClassExtensions.isJavaClass(method.getDeclaringClass())) {
073                return;
074            }
075            processClassContext.removeMethod(method);
076            FacetUtil.addFacet(new TitleFacetViaToStringMethod(method, facetHolder));
077
078        } catch (final Exception e) {
079            return;
080        }
081    }
082}