de.factoryfx.data.attribute.ReferenceBaseAttribute Maven / Gradle / Ivy

Go to download
package de.factoryfx.data.attribute;

import com.fasterxml.jackson.annotation.JsonIgnore;
import de.factoryfx.data.Data;

import java.util.*;
import java.util.function.BiConsumer;
import java.util.function.Function;

/** Base for Reference attributes, with common api  */
public abstract class ReferenceBaseAttribute> extends Attribute {

    protected Data root;
    protected Data parent;//data that contains this attribute
//    protected Class containingFactoryClass;



    public ReferenceBaseAttribute() {
        super();
    }

//    /**
//     * @param attributeMetadata AttributeMetadata
//     * @param containingFactoryClass class off the factory in this Attribute, workaround for java generics Type Erasure.
( workaround for generic parameter ReferenceAttribute> webGuiResource=new ReferenceAttribute(Example) )
//     */
//    @SuppressWarnings("unchecked")
//    public ReferenceBaseAttribute(AttributeMetadata attributeMetadata, Class containingFactoryClass) {
//        super(attributeMetadata);
//        this.containingFactoryClass = containingFactoryClass;
//    }

    private Function> possibleValueProviderFromRoot;

    /**customise the list of selectable items
     * @param provider provider
     * @return self*/
    @SuppressWarnings("unchecked")
    public A possibleValueProvider(Function> provider){
        possibleValueProviderFromRoot=provider;
        return (A)this;
    }

    @SuppressWarnings("unchecked")
    public Collection internal_possibleValues(){
        if (clazz!=null && possibleValueProviderFromRoot==null){
            possibleValueProviderFromRoot=new DefaultPossibleValueProvider<>(clazz);
        }
        if (possibleValueProviderFromRoot!=null){
            return possibleValueProviderFromRoot.apply(root);
        }
        return new ArrayList<>();
    }

    @Override
    public void internal_prepareUsage(Data root, Data parent){
        this.root=root;
        this.parent=parent;
    }

    private Function newValueProvider;
    /**
     * customise how new values are created
     * @param newValueProviderFromRoot value, root
     * @return the new added factory
     */
    @SuppressWarnings("unchecked")
    public A newValueProvider(Function newValueProviderFromRoot){
        this.newValueProvider =newValueProviderFromRoot;
        return (A)this;
    }

    protected Function getNewValueProvider(){
        if (clazz!=null && newValueProvider==null){
            newValueProvider=new DefaultNewValueProvider<>(clazz);
        }
        return newValueProvider;
    }

    Function> newValuesProvider;
    /**
     * customise how new values are created
     * @param newValuesProvider value, root
     * @return the new added factory
     */
    @SuppressWarnings("unchecked")
    public A newValuesProvider(Function> newValuesProvider){
        this.newValuesProvider = newValuesProvider;
        return (A)this;
    }

    protected BiConsumer additionalDeleteAction;
    /**
     * action after delete, e.g delete the factory also in other lists
     * @param additionalDeleteAction deleted value, root
     * @return self
     */
    @SuppressWarnings("unchecked")
    public A additionalDeleteAction(BiConsumer additionalDeleteAction){
        this.additionalDeleteAction=additionalDeleteAction;
        return (A)this;
    }

    private boolean userEditable=true;
    /**
     * marks the reference as readonly for the user(user can still navigate but not change the reference)
     * @return self
     */
    @SuppressWarnings("unchecked")
    public A userReadOnly(){
        userEditable=false;
        return (A)this;
    }

    @JsonIgnore
    public boolean internal_isUserEditable(){
        return userEditable;
    }

    private boolean userSelectable=true;
    /**
     * disable select for reference, used in gui to disable the select button so that the user can't select new factories in this attribute
     * @return self
     */
    @SuppressWarnings("unchecked")
    public A userNotSelectable(){
        userSelectable=false;
        return (A)this;
    }

    @JsonIgnore
    public boolean internal_isUserSelectable(){
        return userSelectable;
    }


    private boolean userCreatable =true;
    /**
     * disable new for reference, used in gui to disable the new button so that the user can't create new factories in this attribute
     * @return self
     */
    @SuppressWarnings("unchecked")
    public A userNotCreatable(){
        userCreatable =false;
        return (A)this;
    }

    @JsonIgnore
    public boolean internal_isUserCreatable(){
        return userCreatable;
    }

    protected CopySemantic copySemantic = CopySemantic.COPY;

    /**
     * @see Data.DataUtility#semanticCopy()
     *
     * @param copySemantic copySemantic
     * @return self*/
    @SuppressWarnings("unchecked")
    public A setCopySemantic(CopySemantic copySemantic){
        this.copySemantic=copySemantic;
        return (A)this;
    }

    protected Class clazz;
    /**setup value selection and new value adding for user editing
     * @param clazz class
     * @return self*/
    @SuppressWarnings("unchecked")
    protected A setup(Class clazz){
        this.clazz=clazz;//lazy creation for performance
        return (A)this;
    }

    public Class internal_getReferenceClass(){
        return clazz;
    }

    /** workaround for java limitations width nested generic parameter e.g.: Class<TypA<TypB>>  

     * if possible use {@link #setup} instead
     * @param clazz class
     * @return self
     */
    @SuppressWarnings("unchecked")
    protected A setupUnsafe(Class clazz){
        if (!Data.class.isAssignableFrom(clazz)){
            throw new IllegalArgumentException(clazz+" is no data class, maybe mixed up with liveobject class");
        }
        return setup((Class)clazz);
    }

    /**
     * reference is a selection from a catalogue
     * @return self
     */
    @SuppressWarnings("unchecked")
    public A catalogueBased(){
        catalogueBased=true;
        setCopySemantic(CopySemantic.SELF);
        return (A)this;
    }

    @JsonIgnore
    public boolean internal_isCatalogueBased(){
        return catalogueBased;
    }

    private boolean catalogueBased =false;


}