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.encodeable;
021
022import org.apache.isis.applib.adapters.EncoderDecoder;
023import org.apache.isis.core.commons.lang.ClassExtensions;
024import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
025import org.apache.isis.core.metamodel.adapter.mgr.AdapterManager;
026import org.apache.isis.core.metamodel.facetapi.FacetAbstract;
027import org.apache.isis.core.metamodel.facetapi.FacetHolder;
028import org.apache.isis.core.metamodel.facets.object.encodeable.EncodableFacet;
029import org.apache.isis.core.metamodel.runtimecontext.ServicesInjector;
030
031public abstract class EncodableFacetAbstract extends FacetAbstract implements EncodableFacet {
032
033    private final Class<?> encoderDecoderClass;
034
035    // to delegate to
036    private final EncodableFacetUsingEncoderDecoder encodeableFacetUsingEncoderDecoder;
037
038    private final AdapterManager adapterManager;
039    private final ServicesInjector dependencyInjector;
040
041    public EncodableFacetAbstract(final String candidateEncoderDecoderName, final Class<?> candidateEncoderDecoderClass, final FacetHolder holder, final AdapterManager adapterManager, final ServicesInjector dependencyInjector) {
042        super(EncodableFacet.class, holder, Derivation.NOT_DERIVED);
043        this.adapterManager = adapterManager;
044        this.dependencyInjector = dependencyInjector;
045
046        this.encoderDecoderClass = EncoderDecoderUtil.encoderDecoderOrNull(candidateEncoderDecoderClass, candidateEncoderDecoderName);
047        if (isValid()) {
048            final EncoderDecoder<?> encoderDecoder = (EncoderDecoder<?>) ClassExtensions.newInstance(encoderDecoderClass, FacetHolder.class, holder);
049            this.encodeableFacetUsingEncoderDecoder = new EncodableFacetUsingEncoderDecoder(encoderDecoder, holder, getAdapterManager(), getDependencyInjector());
050        } else {
051            this.encodeableFacetUsingEncoderDecoder = null;
052        }
053    }
054
055    /**
056     * Discover whether either of the candidate encoder/decoder name or class is
057     * valid.
058     */
059    public boolean isValid() {
060        return encoderDecoderClass != null;
061    }
062
063    /**
064     * Guaranteed to implement the {@link EncoderDecoder} class, thanks to
065     * generics in the applib.
066     */
067    public Class<?> getEncoderDecoderClass() {
068        return encoderDecoderClass;
069    }
070
071    @Override
072    protected String toStringValues() {
073        return encoderDecoderClass.getName();
074    }
075
076    @Override
077    public ObjectAdapter fromEncodedString(final String encodedData) {
078        return encodeableFacetUsingEncoderDecoder.fromEncodedString(encodedData);
079    }
080
081    @Override
082    public String toEncodedString(final ObjectAdapter object) {
083        return encodeableFacetUsingEncoderDecoder.toEncodedString(object);
084    }
085
086    public AdapterManager getAdapterManager() {
087        return adapterManager;
088    }
089
090    public ServicesInjector getDependencyInjector() {
091        return dependencyInjector;
092    }
093
094}