/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */
package org.apache.causeway.core.metamodel.facets.all.i8n.noun;

import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;

import org.apache.causeway.applib.services.i18n.TranslationContext;
import org.apache.causeway.commons.internal.base._Lazy;
import org.apache.causeway.core.metamodel.facetapi.Facet;
import org.apache.causeway.core.metamodel.facetapi.FacetAbstract;
import org.apache.causeway.core.metamodel.facetapi.FacetHolder;

import org.jspecify.annotations.NonNull;

public abstract class HasNounFacetAbstract
extends FacetAbstract
implements HasNoun {

    protected final TranslationContext translationContext;

    private final @NonNull Noun noun;
    private final @NonNull _Lazy<Noun> translatedNounForms;

    protected HasNounFacetAbstract(
            final Class<? extends Facet> facetType,
            final TranslationContext translationContext,
            final Noun noun,
            final FacetHolder holder) {
        this(facetType, translationContext, noun, holder, Precedence.DEFAULT);
    }

    protected HasNounFacetAbstract(
            final Class<? extends Facet> facetType,
            final TranslationContext translationContext,
            final Noun noun,
            final FacetHolder holder,
            final Precedence precedence) {
        super(facetType, holder, precedence);
        this.noun = noun;
        this.translationContext = translationContext;
        this.translatedNounForms = _Lazy.threadSafe(()->
            noun.translate(holder.getTranslationService(), translationContext));
    }

    @Override
    public boolean isNounPresent() {
        return noun.isPresent();
    }

    @Override
    public final Optional<String> text() {
        return noun.literal();
    }

    @Override
    public final Optional<String> translated() {
        return translatedNounForms.get().literal();
    }

    @Override
    public void visitAttributes(final BiConsumer<String, Object> visitor) {
        super.visitAttributes(visitor);
        visitor.accept("context", translationContext);
        if(noun.isPresent()) {
            visitor.accept("hasNoun", "true");
            visitor.accept("originalText", text());
            visitor.accept("translated", translated()); // memoizes as a side-effect
        } else {
            visitor.accept("hasNoun", "false");
        }
    }

    @Override
    public boolean semanticEquals(final @NonNull Facet other) {

        // equality by facet-type, (original) text and translation-context

        if(!this.facetType().equals(other.facetType())) {
            return false;
        }

        var otherFacet =  (HasNounFacetAbstract)other;

        return Objects.equals(this.noun, otherFacet.noun)
                && Objects.equals(this.translationContext, otherFacet.translationContext);

    }

}
