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