net.segoia.util.data.repository.ObjectsRepository Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons Show documentation
Various Java Utils
The newest version!
/**
 * commons - Various Java Utils
 * Copyright (C) 2009  Adrian Cristian Ionescu - https://github.com/acionescu
 *
 * Licensed 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 net.segoia.util.data.repository;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;

import net.segoia.util.data.ObjectsUtil;
import net.segoia.util.data.SetMap;
import net.segoia.util.data.reflection.ReflectionUtility;

/**
 * Implements a repository for a certain type of object (all the objects should
 * share a common interface) this can also be used as a repository of
 * repositories
 * 
 * @author adi
 * 
 * @param 
 */
public class ObjectsRepository implements Serializable {
    /**
     * 
     */
    private static final long serialVersionUID = -2852851812850022179L;
    /**
     * keeps a map with all the maps used to search objects by certain
     * properties 
 key - the name of the property used to search 

     * value - the map with all the mapped values for the property
     */
    private Map> indexMap = new TreeMap>();
    /**
     * the list of searchable properties
     */
    private List indexProperties = new ArrayList();

    private Set allObjects = new HashSet();

    public ObjectsRepository() {

    }

    /**
     * @return the indexProperties
     */
    public List getIndexProperties() {
	return indexProperties;
    }

    /**
     * @param indexProperties
     *            the indexProperties to set
     */
    public void setIndexProperties(List indexProperties) {
	this.indexProperties = indexProperties;
    }

    public void addIndexProperty(String property) {
	if (!indexProperties.contains(property)) {
	    indexProperties.add(property);
	}
    }

    public boolean addObject(O obj) {
	boolean added = allObjects.add(obj);
	if (added) {
	    buildIndexesForObject(obj);
	}
	return added;
    }

    public int addObjects(Collection c) {
	int addedCount = 0;
	for (O o : c) {
	    boolean added = addObject(o);
	    if (added) {
		addedCount++;
	    }
	}
	return addedCount;
    }

    /**
     * adds the current object to the indexes according to the specified index
     * properties
     * 
     * @param obj
     */
    private void buildIndexesForObject(O obj) {
	for (String prop : indexProperties) {
	    try {
		Object value = ReflectionUtility.getValueForField(obj, prop);
		/* get the map for the current property */
		SetMap listMap = indexMap.get(prop);
		if (listMap == null) {
		    listMap = SetMap.createTreeMapWithTreeSet();
		    indexMap.put(prop, listMap);
		}
		listMap.add(value, obj);
	    } catch (Exception e) {
		System.out.println("Error building index for prop " + prop
			+ " on object " + obj);
		e.printStackTrace();
		/* do nothing */
	    }
	}
    }

    /**
     * Returns the list of objects that have the specified value for the
     * property
     * 
     * @param propName
     * @param propValue
     * @return
     */
    public Collection getObjectsForProperty(String propName,
	    Object propValue) {
	SetMap valuesMap = indexMap.get(propName);
	if (valuesMap == null) {
	    return null;
	}
	return valuesMap.get(propValue);
    }

    /**
     * Will return the first object from the list found for the specified search
     * criteria
     * 
     * @param propName
     * @param propValue
     * @return
     */
    public O getSingleObjectForProperty(String propName, Object propValue) {
	Collection valCol = getObjectsForProperty(propName, propValue);
	if (valCol == null || valCol.size() == 0) {
	    return null;
	}
	List valList = new ArrayList(valCol);

	return valList.get(0);
    }

    public Map getObjectsMapForProperty(String searchPropName,
	    Object searchValue, String keyPropName) {
	Collection list = getObjectsForProperty(searchPropName,
		searchValue);
	return (Map) ObjectsUtil.createMapFromCollection(list, keyPropName);
    }

    /**
     * Returns a map with the keys representing the possible values for the
     * specified property and the value representing the list with the objects
     * that have the property value equal with the key
     * 
     * @param propName
     * @return
     */
    public Map> getObjectsByProperty(String propName) {
	return indexMap.get(propName).getAll();
    }

    public Collection