SObject.java

/*
 * Copyright (C) 2011 Citrix Systems, Inc.  All rights reserved.
 * 
 * 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 com.cloud.bridge.model;

import java.io.Serializable;
import java.util.Date;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Set;

/**
 * @author Kelven Yang, John Zucker
 */
public class SObject implements Serializable {
	private static final long serialVersionUID = 8566744941395660486L;

	private Long id;
	
	private String nameKey;
	private String ownerCanonicalId;
	
	private int nextSequence;
	private String deletionMark;   // This must also a unique ID to give to the REST client
	
	private Date createTime;
	
	private SBucket bucket;
	
	private Set<SObjectItem> items = new HashSet<SObjectItem>();

	public SObject() {
		deletionMark = null;
	}
	
	public Long getId() {
		return id;
	}

	private void setId(Long id) {
		this.id = id;
	}
	
	public String getNameKey() {
		return nameKey;
	}

	public void setNameKey(String nameKey) {
		this.nameKey = nameKey;
	}

	public String getOwnerCanonicalId() {
		return ownerCanonicalId;
	}

	public void setOwnerCanonicalId(String ownerCanonicalId) {
		this.ownerCanonicalId = ownerCanonicalId;
	}

	public int getNextSequence() {
		return nextSequence;
	}

	public void setNextSequence(int nextSequence) {
		this.nextSequence = nextSequence;
	}

	public String getDeletionMark() {
		return deletionMark;
	}

	public void setDeletionMark(String deletionMark) {
		this.deletionMark = deletionMark;
	}

	public Date getCreateTime() {
		return createTime;
	}

	public void setCreateTime(Date createTime) {
		this.createTime = createTime;
	}
	
	public SBucket getBucket() {
		return bucket;
	}

	public void setBucket(SBucket bucket) {
		this.bucket = bucket;
	}
	
	public Set<SObjectItem> getItems() {
		return items;
	}

	public void setItems(Set<SObjectItem> items) {
		this.items = items;
	}
	
	public void deleteItem( long id ) {
		Iterator<SObjectItem> it = getItems().iterator();
	
		while( it.hasNext()) 
		{
			SObjectItem oneItem = it.next();
			if (id == oneItem.getId()) {
				boolean bRemoved = items.remove( oneItem );
				System.out.println( "deleteItem from sobject: " + bRemoved );
				return;
			}
		}
	}
	
	public SObjectItem getLatestVersion( boolean versioningOff ) {
		Iterator<SObjectItem> it = getItems().iterator();
		int maxVersion = 0;
		int curVersion = 0;
		SObjectItem latestItem = null;
		
		while( it.hasNext()) 
		{
			SObjectItem item = it.next();
			
		    //    If versioning is off then return the item with the null version string (if exists)
			//    For example, the bucket could have allowed versioning and then it was suspended
			//    If an application wants a specific version it will need to explicitly ask for it
			try {
                String version = item.getVersion();
                if (versioningOff && null == version) {
                	return item;
                }
				curVersion = Integer.parseInt( version );
				
			} catch (NumberFormatException e) {
				curVersion = 0;
			}
			
			if(curVersion >= maxVersion) {
				maxVersion = curVersion;
				latestItem = item;
			}
		}
		return latestItem;
	}
	
	/**
	 * S3 versioning allows the client to request the return of a specific version,
	 * not just the last version.
	 * 
	 * @param wantVersion
	 * @return
	 */
	public SObjectItem getVersion( String wantVersion ) 
	{
		Iterator<SObjectItem> it = getItems().iterator();	
		while( it.hasNext()) 
		{
			SObjectItem item = it.next();
			String curVersion = item.getVersion();
			if (null != curVersion && wantVersion.equalsIgnoreCase( curVersion )) return item;				
		}
		return null;
	}

	@Override
	public boolean equals(Object other) {
		if(this == other)
			return true;
		
		if(!(other instanceof SObject))
			return false;
		
		if(!getNameKey().equals(((SObject)other).getNameKey()))
			return false;
		
		if(getBucket() != null) {
			if(!getBucket().equals(((SObject)other).getBucket()))
				return false;
		} else {
			if(((SObject)other).getBucket() != null)
				return false;
		}
		
		return true;
	}
	
	@Override
	public int hashCode() {
		int hashCode = 0;
		hashCode = hashCode*17 + getNameKey().hashCode();
		
		if(getBucket() != null)
			hashCode = hashCode*17 + getBucket().hashCode(); 
		return hashCode;
	}
}