org.cloudgraph.config.PreDefinedKeyFieldConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cloudgraph-config Show documentation
CloudGraph(tm) is a suite of Service Data Object (SDO) 2.1 services designed for relational and big-table style "cloud" databases, such as HBase and others.
There is a newer version: 0.7.1
Show newest version
/**
 *        CloudGraph Community Edition (CE) License
 * 
 * This is a community release of CloudGraph, a dual-license suite of
 * Service Data Object (SDO) 2.1 services designed for relational and 
 * big-table style "cloud" databases, such as HBase and others. 
 * This particular copy of the software is released under the 
 * version 2 of the GNU General Public License. CloudGraph was developed by 
 * TerraMeta Software, Inc.
 * 
 * Copyright (c) 2013, TerraMeta Software, Inc. All rights reserved.
 * 
 * General License information can be found below.
 * 
 * This distribution may include materials developed by third
 * parties. For license and attribution notices for these
 * materials, please refer to the documentation that accompanies
 * this distribution (see the "Licenses for Third-Party Components"
 * appendix) or view the online documentation at 
 * . 
 */
package org.cloudgraph.config;

import javax.xml.namespace.QName;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.plasma.sdo.DataFlavor;
import org.plasma.sdo.PlasmaDataObject;
import org.plasma.sdo.PlasmaProperty;
import org.plasma.sdo.PlasmaType;

import commonj.sdo.DataGraph;
import commonj.sdo.DataObject;

/**
 * Encapsulates logic related to access of a configured
 * pre-defined row or column key field. 
 * @author Scott Cinnamond
 * @since 0.5.1
 */
public class PreDefinedKeyFieldConfig extends KeyFieldConfig {

	private static final Log log = LogFactory.getLog(PreDefinedKeyFieldConfig.class);
	private PredefinedField field;
	
	public PreDefinedKeyFieldConfig(PredefinedField field, 
		int seqNum, int totalFields) {
		super(field, seqNum, totalFields);
		this.field = field;
	}

	public PredefinedField getField() {
		return field;
	}
	
	public PreDefinedFieldName getName()
	{
	    return field.getName();
	}
	
    public boolean isHash() {
    	return field.isHash();
    }	
    
	@Override
	public String getKey(DataGraph dataGraph) {
		return getKey(dataGraph.getRootObject());
	}

	@Override
	public String getKey(DataObject dataObject) {
		PlasmaType rootType = (PlasmaType)dataObject.getType();
		
		String result = null;
		switch (this.getName()) {
		case URI: 
			result = rootType.getURI();
			break;
		case TYPE:
			result = rootType.getPhysicalName();
			if (result == null || result.length() == 0) {
				if (log.isDebugEnabled())
				    log.debug("no physical name for type, "
				    		+ rootType.toString()
				    		+ ", defined - using logical name");
				result = rootType.getName();
			}
			break;
		case PKG:
			result = rootType.getPackagePhysicalName();
			if (result == null || result.length() == 0) {
				if (log.isDebugEnabled())
				    log.debug("no physical package name for type, "
				    		+ rootType.toString()
				    		+ ", defined - using URI");
				result = rootType.getURI();
			}
			break;
		case UUID:
			result = ((PlasmaDataObject)dataObject).getUUIDAsString();
			break;
		default:
		    throw new CloudGraphConfigurationException("invalid row key field name, "
		    		+ this.getName().name() + " - cannot get this field from a Data Graph");
		}
		
		return result;
	}
   
	/**
	 * Returns a key value from the given Data Graph
	 * @param dataGraph the data graph 
	 * @return the key value
	 */
	public byte[] getKeyBytes(
			commonj.sdo.DataGraph dataGraph) {
		return this.getKeyBytes(dataGraph.getRootObject());
	}

	/**
	 * Returns a key value from the given data object
	 * @param dataObject the root data object 
	 * @return the key value
	 */
	public byte[] getKeyBytes(
			DataObject dataObject) 
	{
		PlasmaType rootType = (PlasmaType)dataObject.getType();
		
		byte[] result = null;
		switch (this.getName()) {
		case URI: 
			result = rootType.getURIBytes();
			break;
		case TYPE:
			result = rootType.getPhysicalNameBytes();
			if (result == null || result.length == 0) {
				if (log.isDebugEnabled())
				    log.debug("no physical name bytes for type, "
				    		+ rootType.toString()
				    		+ ", defined - using logical name bytes");
				result = rootType.getNameBytes();
			}
			break;
		case PKG:
			result = rootType.getPackagePhysicalNameBytes();
			if (result == null || result.length == 0) {
				if (log.isDebugEnabled())
				    log.debug("no physical package name bytes for type, "
				    		+ rootType.toString()
				    		+ ", defined - using URI bytes");
				result = rootType.getURIBytes();
			}
			break;
		case UUID:
			result = ((PlasmaDataObject)dataObject).getUUIDAsString().getBytes(charset);
			break;
		default:
		    throw new CloudGraphConfigurationException("invalid row key field name, "
		    		+ this.getName().name() + " - cannot get this field from a Data Graph");
		}
		
		return result;
	}
    
	/**
	 * Returns a key value from the given type
	 * @param type the type 
	 * @return the key value
	 */
	public byte[] getKeyBytes(PlasmaType type, PlasmaProperty property) {
		switch (this.getName()) {
		case URI: 
		case TYPE:
		case PKG:
			return getKeyBytes(type);
		case PROPERTY:
			return getKeyBytes(property);
		default:
		    throw new CloudGraphConfigurationException("invalid predefined key field name, "
		    		+ this.getName().name() + " - cannot get this predefined field from a type or property");
		}
	}
	
	/**
	 * Returns a key value from the given type
	 * @param type the type 
	 * @return the key value
	 */
	public byte[] getKeyBytes(PlasmaType type) 
	{
		byte[] result = null;
		switch (this.getName()) {
		case URI: 
			result = type.getURIBytes();
			break;
		case TYPE:
			result = type.getPhysicalNameBytes();
			if (result == null || result.length == 0) {
				if (log.isDebugEnabled())
				    log.debug("no physical name for type, "
				    		+ type.toString() 
				    		+ ", defined - using logical name");
				result = type.getNameBytes();
			}
			break;
		case PKG:
			result = type.getPackagePhysicalNameBytes();
			if (result == null || result.length == 0) {
				if (log.isDebugEnabled())
				    log.debug("no physical package name bytes for type, "
				    		+ type.toString() 
				    		+ ", defined - using URI bytes");
				result = type.getURIBytes();
			}
			break;
		default:
		    throw new CloudGraphConfigurationException("invalid predefined key field name, "
		    		+ this.getName().name() + " - cannot get this predefined field from a type");
		}
		
		return result;
	}
	
	/**
	 * Returns a key value from the given type
	 * @param type the type 
	 * @return the key value
	 */
	public byte[] getKeyBytes(PlasmaProperty property) 
	{
		byte[] result = null;
		switch (this.getName()) {
		case PROPERTY:
			result = property.getPhysicalNameBytes();
			if (result == null || result.length == 0) {
				if (log.isDebugEnabled())
				    log.debug("no physical name for type, "
				    		+ property.toString() 
				    		+ ", defined - using logical name");
				result = property.getNameBytes();
			}
			break;
		default:
		    throw new CloudGraphConfigurationException("invalid predefined key field name, "
		    		+ this.getName().name() + " - cannot get this predefined field from a property");
		}
		
		return result;
	}
	

	// FIXME: drive these from 
	// global configuration settings
	@Override
	public int getMaxLength() {
		switch (this.getName()) {
		case URI: 
			return 12;
		case TYPE:
			return 32;
		case UUID:
			return 36;
		default:
			return 12;
		}
	}
	
	public DataFlavor getDataFlavor() {
		switch (this.getName()) {
		case URI: 
			return DataFlavor.string;
		case TYPE:
			return DataFlavor.string;
		case UUID:
			return DataFlavor.string;
		default:
			return DataFlavor.string;
		}
	}

}