All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.github.TKnudsen.ComplexDataObject.data.features.AbstractFeatureVector Maven / Gradle / Ivy

Go to download

A library that models real-world objects in Java, referred to as ComplexDataObjects. Other features: IO and preprocessing of ComplexDataObjects.

There is a newer version: 0.2.13
Show newest version
package com.github.TKnudsen.ComplexDataObject.data.features;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.SortedMap;
import java.util.TreeMap;

import com.github.TKnudsen.ComplexDataObject.data.interfaces.IDObject;
import com.github.TKnudsen.ComplexDataObject.data.interfaces.IFeatureVectorObject;
import com.github.TKnudsen.ComplexDataObject.data.interfaces.IMasterProvider;
import com.github.TKnudsen.ComplexDataObject.data.interfaces.ISelfDescription;
import com.github.TKnudsen.ComplexDataObject.data.keyValueObject.KeyValueObject;

/**
 * 

 * Title: AbstractFeatureVector
 * 

 * 
 * 

 * Description: general feature representation of a given object. Provides basic
 * attributes and functionality.
 * 

 * 
 * 

 * Copyright: Copyright (c) 2016
 * 

 * 
 * @author Juergen Bernard
 * @version 1.01
 */

public abstract class AbstractFeatureVector> extends KeyValueObject implements ISelfDescription, IMasterProvider, Cloneable, IFeatureVectorObject {

	private String name;

	private String description;

	private IDObject master;

	protected List featuresList;

	protected SortedMap featuresMap;

	public AbstractFeatureVector(List features) {
		this.featuresList = features;
		this.featuresMap = null;
	}

	public AbstractFeatureVector(F[] features) {
		generalizeFromArray(features);
	}

	public AbstractFeatureVector(SortedMap featuresMap) {
		this.featuresMap = featuresMap;

		generalizeFromMap();
	}

	@Override
	public abstract AbstractFeatureVector clone();

	protected void createFeatureNamesMap() {
		featuresMap = null;

		if (featuresList == null)
			return;

		featuresMap = new TreeMap<>();

		for (int i = 0; i < featuresList.size(); i++)
			if (featuresList.get(i) != null && featuresList.get(i).getFeatureName() != null)
				featuresMap.put(featuresList.get(i).getFeatureName(), featuresList.get(i));
		checkFeatureNameConsistency();
	}

	protected void generalizeFromArray(F[] featuresArray) {
		featuresList = null;
		featuresMap = null;

		if (featuresArray == null)
			return;

		featuresList = new ArrayList<>();
		featuresMap = null;

		for (F feature : featuresArray) {
			featuresList.add(feature);
			// refactoring. lazy implementation to save computation time
			// if (feature != null && feature.getFeatureName() != null)
			// featuresMap.put(feature.getFeatureName(), feature);
		}
	}

	protected void generalizeFromMap() {
		featuresList = null;

		if (featuresMap == null)
			return;

		featuresList = new ArrayList<>();
		for (String s : featuresMap.keySet())
			featuresList.add(featuresMap.get(s));
	}

	/**
	 * really nececssary?
	 * 
	 * @param featureName
	 * @return
	 */
	protected boolean checkForDuplicateFeatureName(String featureName) {
		for (F entry : featuresList)
			if (entry != null && entry.getFeatureName() != null)
				if (featureName.equals(entry.getFeatureName()))
					return true;
		return false;
	}

	/**
	 * really necessary?
	 */
	protected void checkForDuplicateFeatureNames() {
		Set featureNames = new HashSet();
		String errorString = "";

		for (F entry : featuresList)
			if (entry != null && entry.getFeatureName() != null)
				if (featureNames.contains(entry.getFeatureName()))
					errorString = (errorString + entry.getFeatureName() + ", ");
				else
					featureNames.add(entry.getFeatureName());

		if (!errorString.equals(""))
			throw new IllegalArgumentException("FeatureVector - duplicate Features: " + errorString.substring(0, errorString.length() - 2));
	}

	private boolean checkFeatureNameConsistency() {
		if (featuresList != null) {
			if (featuresList.size() != getFeaturesMap().size())
				throw new IllegalArgumentException("FeatureVector: name conflict, features with identical name?");
		}

		return true;
	}

	@Override
	public F getFeature(int index) {
		if (featuresList != null)
			if (featuresList.size() > index)
				return featuresList.get(index);
			else
				throw new IndexOutOfBoundsException();
		return null;
	}

	@Override
	public F getFeature(String featureName) {
		if (getFeaturesMap() != null)
			return getFeaturesMap().get(featureName);
		return null;
	}

	/**
	 * Expensive variant of adding a feature into the internal data
	 * representations.
	 */
	public void addFeature(F feature) {
		if (feature == null)
			return;

		if (featuresList == null)
			featuresList = new ArrayList<>();
		if (featuresMap == null)
			featuresMap = new TreeMap<>();

		if (!featuresList.contains(feature))
			for (int i = 0; i < featuresList.size(); i++)
				if (featuresList.get(i).getFeatureName().equals(feature.getFeatureName())) {
					featuresList.set(i, feature);
					featuresMap.put(feature.getFeatureName(), feature);
					return;
				}

		featuresList.add(feature);
		featuresMap.put(feature.getFeatureName(), feature);
	}

	@Override
	/**
	 * Sets a feature at a given index. Does not handle index exceptions.
	 * 
	 * @param index
	 * @param feature
	 */
	public void setFeature(int index, F feature) {
		if (featuresList != null)
			featuresList.set(index, feature);

		if (featuresMap != null) {
			if (!featuresMap.containsKey(feature.getFeatureName()))
				featuresMap.put(feature.getFeatureName(), feature);
			else
				throw new IllegalArgumentException("FeatureVector: name conflict, features with identical name");
		}
	}

	@Override
	public F removeFeature(String featureName) {
		F feature = featuresMap.remove(featureName);

		if (featuresList != null)
			if (feature != null) {
				featuresList.remove(feature);
				return feature;
			} else
				for (F f : featuresList)
					if (f.getFeatureName().equals(featureName)) {
						featuresList.remove(f);
						return f;
					}

		return feature;
	}

	@Override
	public List getVectorRepresentation() {
		return Collections.unmodifiableList(featuresList);
	}

	/**
	 * Features always describes the individual features of the vector. In
	 * contrast, getAttributes() retrieves the metadata.
	 */
	@Override
	public Set getFeatureKeySet() {
		if (getFeaturesMap() == null)
			return null;

		return getFeaturesMap().keySet();
	}

	@Override
	public int sizeOfFeatures() {
		return featuresList.size();
	}

	public int getDimensions() {
		return featuresList.size();
	}

	@Override
	/**
	 * If the FeatureDataObject is derived from another IDObject this can be
	 * specified here.
	 */
	public IDObject getMaster() {
		return master;
	}

	/**
	 * Get the IDObject of the FeatureDataObject - if specified.
	 * 
	 * @param master
	 */
	public void setMaster(IDObject master) {
		this.master = master;
	}

	@Override
	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	@Override
	public String getDescription() {
		return description;
	}

	public void setDescription(String description) {
		this.description = description;
	}

	@Override
	public int hashCode() {
		int hash = 1;

		if (master != null)
			hash = 37 * hash + master.hashCode();

		if (featuresList == null)
			hash = 37 * hash;
		else
			for (F feature : featuresList)
				hash = 37 * hash + feature.hashCode();

		return hash;
	}

	@Override
	public String toString() {
		String string = this.getName() + ", " + this.getID() + ", dim: " + getDimensions() + "\t";

		// string += "[";
		// for (F feature : this.getVectorRepresentation())
		// string += feature.toString();
		// string += "]\t";

		return string;
	}

	protected Map getFeaturesMap() {
		if (featuresMap == null)
			createFeatureNamesMap();

		return featuresMap;
	}
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy