All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.databene.model.data.FeatureDescriptor Maven / Gradle / Ivy

    package org.databene.model.data;

import org.databene.commons.Named;
import org.databene.commons.NullSafeComparator;
import org.databene.commons.Operation;
import org.databene.commons.StringUtil;
import org.databene.commons.collection.OrderedNameMap;
import org.databene.commons.converter.AnyConverter;
import org.databene.commons.converter.ConverterManager;
import org.databene.commons.converter.String2ConverterConverter;
import org.databene.commons.converter.ToStringConverter;

import java.util.List;

/**
 * Common parent class of all descriptors.

    
 * Created: 17.07.2006 21:30:45
 * @since 0.1
 * @author Volker Bergmann
 */
public class FeatureDescriptor implements Named {

    public static final String NAME = "name";

    static {
        ConverterManager.getInstance().registerConverterClass(String2ConverterConverter.class);
    }

    protected OrderedNameMap> details;
    protected DescriptorProvider owner;

    // constructor -----------------------------------------------------------------------------------------------------

    public FeatureDescriptor(String name, DescriptorProvider owner) {
    	if (owner == null)
    		throw new IllegalArgumentException("owner is null");
    	if (owner.getDataModel() == null)
    		throw new IllegalArgumentException("owner's data model is null");
        this.details = new OrderedNameMap>();
        this.owner = owner;
        this.addConstraint(NAME, String.class, null);
        this.setName(name);
    }
    
    // typed interface -------------------------------------------------------------------------------------------------
/*
    public void setParent(FeatureDescriptor parent) {
        this.parent = parent;
    }
*/
    public String getName() {
        return (String) getDetailValue(NAME);
    }

    public void setName(String name) {
        setDetailValue(NAME, name);
    }
    
    public DescriptorProvider getOwner() {
    	return owner;
    }
    
    public DataModel getDataModel() {
    	return owner.getDataModel();
    }

    // generic detail access -------------------------------------------------------------------------------------------

    public boolean supportsDetail(String name) {
        return details.containsKey(name);
    }

    public Object getDeclaredDetailValue(String name) { // TODO v0.8 remove method? It does not differ from getDetailValue any more
        return getConfiguredDetail(name).getValue();
    }

    public Object getDetailValue(String name) { // TODO v0.8 remove generic feature access?
        return this.getConfiguredDetail(name).getValue();
    }

    public void setDetailValue(String detailName, Object detailValue) {
        FeatureDetail detail = getConfiguredDetail(detailName);
        detail.setValue(AnyConverter.convert(detailValue, detail.getType()));
    }

    public List> getDetails() {
        return details.values();
    }

    // java.lang overrides ---------------------------------------------------------------------------------------------

    @Override
	public String toString() {
        String name = getName();
        if (StringUtil.isEmpty(name))
            name = "anonymous";
        return renderDetails(new StringBuilder(name)).toString();
    }

    @Override
	public boolean equals(Object o) {
        if (this == o)
            return true;
        if (o == null || getClass() != o.getClass())
            return false;
        final FeatureDescriptor that = (FeatureDescriptor) o;
        for (FeatureDetail detail : details.values()) {
            String detailName = detail.getName();
            if (!NullSafeComparator.equals(detail.getValue(), that.getDetailValue(detailName)))
                return false;
        }
        return true;
    }

    @Override
	public int hashCode() {
        return (getClass().hashCode() * 29 /*+ (parent != null ? parent.hashCode() : 0)*/) * 29 + details.hashCode();
    }

    // helpers ---------------------------------------------------------------------------------------------------------

	protected String renderDetails() {
		return renderDetails(new StringBuilder()).toString();
	}
	
	protected StringBuilder renderDetails(StringBuilder builder) {
		builder.append("[");
        boolean empty = true;
        for (FeatureDetail descriptor : details.values())
            if (descriptor.getValue() != null && !NAME.equals(descriptor.getName())) {
                if (!empty)
                    builder.append(", ");
                empty = false;
                builder.append(descriptor.getName()).append("=");
                builder.append(ToStringConverter.convert(descriptor.getValue(), "[null]"));
            }
        return builder.append("]");
	}

    protected Class getDetailType(String detailName) {
        FeatureDetail detail = details.get(detailName);
        if (detail == null)
            throw new UnsupportedOperationException("Feature detail not supported: " + detailName);
        return detail.getType();
    }

    protected  void addConfig(String name, Class type) {
    	addConfig(name, type, false);
    }

    protected  void addConfig(String name, Class type, boolean deprecated) {
        addDetail(name, type, false, deprecated, null);
    }

    protected  void addConstraint(String name, Class type, Operation combinator) {
        addDetail(name, type, true, false, combinator);
    }

    protected  void addDetail(String detailName, Class detailType, boolean constraint, 
    		boolean deprecated, Operation combinator) {
        this.details.put(detailName, new FeatureDetail(detailName, detailType, constraint, combinator));
    }

    // generic property access -----------------------------------------------------------------------------------------

    @SuppressWarnings("unchecked")
    public  FeatureDetail getConfiguredDetail(String name) {
    	if (!supportsDetail(name))
            throw new UnsupportedOperationException("Feature detail '" + name + 
            		"' not supported in feature type: " + getClass().getName());
        return (FeatureDetail) details.get(name);
    }
    
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy