bundles/org.eclipse.capra.ui.office/src/org/eclipse/capra/ui/office/model/CapraOfficeObject.java

/*******************************************************************************
 * Copyright (c) 2016, 2019 Chalmers | University of Gothenburg, rt-labs and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v2.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v20.html
 *  
 * SPDX-License-Identifier: EPL-2.0
 *  
 * Contributors:
 *      Chalmers | University of Gothenburg and rt-labs - initial API and implementation and/or initial documentation
 *      Chalmers | University of Gothenburg - additional features, updated API
 *******************************************************************************/

package org.eclipse.capra.ui.office.model;

import java.awt.Desktop;
import java.io.File;
import java.io.IOException;
import java.nio.file.NoSuchFileException;

import org.eclipse.capra.ui.office.exceptions.CapraOfficeObjectNotFound;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This class provides a custom object for describing the contents of MS Excel
 * and MS Word related data.
 *
 * @author Dusan Kalanj
 *
 */
public class CapraOfficeObject {
	
	private static final Logger LOG = LoggerFactory.getLogger(CapraOfficeObject.class);

	/**
	 * The MS Office file-types that are supported by the plugin.
	 */
	public static final String DOCX = "docx";
	public static final String XLS = "xls";
	public static final String XLSX = "xlsx";

	/**
	 * The String that separates the file-path from the object-id in the
	 * OfficeObject uri.
	 */
	public static final String URI_DELIMITER = "\\\\::";

	/**
	 * The description of the object (row in Excel, requirement in Word)
	 */
	private String data = "";

	/**
	 * The uri of the object in the form of filePath/objectId
	 */
	private String uri = "";

	/**
	 * A constructor that generates an empty instance of OfficeObject.
	 */
	public CapraOfficeObject() {
	}

	/**
	 * A constructor that generates a new instance of OfficeObject with defined
	 * OfficeData and rowUri properties.
	 */
	public CapraOfficeObject(String data, String uri) {
		this.data = data;
		this.uri = uri;
	}

	/**
	 * Returns the uri of the OfficeObject
	 */
	public String getUri() {
		return uri;
	}

	/**
	 * Sets the uri of the OfficeObject
	 */
	public void setUri(String uri) {
		this.uri = uri;
	}

	/**
	 * Returns the description of the OfficeObject
	 */
	public String getData() {
		return this.data;
	}

	/**
	 * Sets the description of the OfficeObject
	 */
	public void setData(String data) {
		this.data = data;
	}

	/**
	 * Returns the ID of the OfficeObject from its URI. The format of the URI
	 * should always be fileId + DELIMITER + objectId.
	 */
	public String getId() {
		int firstDelimiterIndex = uri.indexOf(URI_DELIMITER);
		return uri.substring(firstDelimiterIndex + URI_DELIMITER.length());
	}

	/**
	 * Returns the File reference of the file that contains the OfficeObject.
	 * The format of the URI should always be fileId + DELIMITER + objectId.
	 */
	public File getFile() throws NoSuchFileException {
		String fileId = getFileId();
		File officeFile = new File(fileId);
		if (officeFile.exists()) {
			return officeFile;
		} else {
			throw new NoSuchFileException(fileId);
		}
	}

	/**
	 * Returns the ID of the file - the first part of the URI. The format of the
	 * URI should always be fileId + DELIMITER + objectId.
	 */
	public String getFileId() {
		int firstDelimiterIndex = uri.indexOf(URI_DELIMITER);
		return uri.substring(0, firstDelimiterIndex);
	}

	/**
	 * Extracts the objectId from the provided CapraOfficeObject uri. The format
	 * of the URI should always be fileId + DELIMITER + objectId.
	 * 
	 * @param uri
	 *            uri of the object
	 * @return ID of the object
	 */
	public static String getObjectIdFromUri(String uri) {
		int firstDelimiterIndex = uri.indexOf(URI_DELIMITER);
		return uri.substring(firstDelimiterIndex + URI_DELIMITER.length());
	}

	/**
	 * Extracts the fileId from the provided CapraOfficeObject uri. The format
	 * of the URI should always be fileId + DELIMITER + objectId.
	 * 
	 * @param uri
	 *            uri of the object
	 * @return file-path of the file that contains the object
	 */
	public static String getFileIdFromUri(String uri) {
		int delimiterIndex = uri.indexOf(URI_DELIMITER);
		return uri.substring(0, delimiterIndex);
	}

	/**
	 * Opens the OfficeObject in its native environment.
	 * 
	 * @return an OK or ERROR message
	 * @throws CapraOfficeObjectNotFound
	 */
	public void showOfficeObjectInNativeEnvironment() throws CapraOfficeObjectNotFound {
		try {
			Desktop.getDesktop().open(getFile());
		} catch (IOException e) {
			LOG.error("Could not oben office file.", e);
			throw new CapraOfficeObjectNotFound(getId(), e);
		}
	}

	/**
	 * Generates a uri given the fileId of the file that contains the object and
	 * an objectId.
	 * 
	 * @param fileId
	 *            ID of the file that contains the object with objectId
	 * @param objectID
	 *            ID of the object
	 * @return a uri of the object in the form of filePath/objectID
	 */
	public static String createUri(String fileId, String objectId) {
		return fileId + URI_DELIMITER + objectId;
	}

	/**
	 * Returns the data of the OfficeObject.
	 */
	@Override
	public String toString() {
		return this.data;
	}

	/**
	 * Provides the hash code of the OfficeObject.
	 */
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + ((data == null) ? 0 : data.hashCode());
		result = prime * result + ((uri == null) ? 0 : uri.hashCode());
		return result;
	}

	/**
	 * Compares two instances of OfficeObject.
	 */
	@Override
	public boolean equals(Object obj) {
		if (this == obj) {
			return true;
		}
		if (obj == null) {
			return false;
		}
		if (getClass() != obj.getClass()) {
			return false;
		}
		CapraOfficeObject other = (CapraOfficeObject) obj;
		if (data == null) {
			if (other.data != null) {
				return false;
			}
		} else if (!data.equals(other.data))
			return false;
		if (uri == null) {
			if (other.uri != null) {
				return false;
			}
		} else if (!uri.equals(other.uri)) {
			return false;
		}
		return true;
	}
}