org.eclipse.dirigible.repository.local.LocalEntity Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) 2010-2018 SAP and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   SAP - initial API and implementation
 */
package org.eclipse.dirigible.repository.local;

import static java.text.MessageFormat.format;

import org.eclipse.dirigible.repository.api.ICollection;
import org.eclipse.dirigible.repository.api.IEntity;
import org.eclipse.dirigible.repository.api.IEntityInformation;
import org.eclipse.dirigible.repository.api.RepositoryNotFoundException;
import org.eclipse.dirigible.repository.api.RepositoryPath;
import org.eclipse.dirigible.repository.api.RepositoryReadException;
import org.eclipse.dirigible.repository.api.RepositoryWriteException;
import org.eclipse.dirigible.repository.fs.FileSystemRepository;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * The file system based implementation of {@link IEntity}.
 */
public abstract class LocalEntity implements IEntity {

	private static final Logger logger = LoggerFactory.getLogger(LocalEntity.class);

	private transient final FileSystemRepository repository;

	private final RepositoryPath path;

	/**
	 * Instantiates a new local entity.
	 *
	 * @param repository
	 *            the repository
	 * @param path
	 *            the path
	 */
	public LocalEntity(FileSystemRepository repository, RepositoryPath path) {
		super();
		this.repository = repository;
		this.path = path;
	}

	/*
	 * (non-Javadoc)
	 * @see org.eclipse.dirigible.repository.api.IEntity#getRepository()
	 */
	@Override
	public FileSystemRepository getRepository() {
		return this.repository;
	}

	/**
	 * Returns the path of this {@link IEntity} represented by an instance of
	 * {@link RepositoryPath}.
	 *
	 * @return the repository path location
	 */
	protected RepositoryPath getRepositoryPath() {
		return this.path;
	}

	/*
	 * (non-Javadoc)
	 * @see org.eclipse.dirigible.repository.api.IEntity#getName()
	 */
	@Override
	public String getName() {
		return this.path.getLastSegment();
	}

	/*
	 * (non-Javadoc)
	 * @see org.eclipse.dirigible.repository.api.IEntity#getPath()
	 */
	@Override
	public String getPath() {
		return this.path.toString();
	}

	/*
	 * (non-Javadoc)
	 * @see org.eclipse.dirigible.repository.api.IEntity#getParent()
	 */
	@Override
	public ICollection getParent() {
		final RepositoryPath parentPath = this.path.getParentPath();
		if (parentPath == null) {
			return null;
		}
		return new LocalCollection(repository, parentPath);
	}

	/*
	 * (non-Javadoc)
	 * @see org.eclipse.dirigible.repository.api.IEntity#getInformation()
	 */
	@Override
	public IEntityInformation getInformation() throws RepositoryReadException {
		return new LocalEntityInformation(this.path, getLocalObjectSafe());
	}

	/**
	 * Returns the {@link LocalObject} that matches this entity's path. If there is
	 * no such object in the real repository, then null is
	 * returned.
	 *
	 * @return the local object
	 * @throws RepositoryReadException
	 *             the repository read exception
	 */
	protected LocalObject getLocalObject() throws RepositoryReadException {
		try {
			return this.repository.getRepositoryDao().getObjectByPath(getPath());
		} catch (LocalRepositoryException ex) {
			logger.error(ex.getMessage(), ex);
			return null;
		}
	}

	/**
	 * Returns the {@link LocalObject} that matches this entity's path. If there is
	 * no such object in the real repository, then an {@link RepositoryNotFoundException} is
	 * thrown.
	 *
	 * @return the {@link LocalObject} that matches this entity's path
	 * @throws RepositoryNotFoundException
	 *             If there is no such object in the real repository
	 */
	protected LocalObject getLocalObjectSafe() throws RepositoryNotFoundException {
		final LocalObject result = getLocalObject();
		if (result == null) {
			throw new RepositoryNotFoundException(format("There is no entity at path ''{0}''.", this.path.toString()));
		}
		return result;
	}

	/**
	 * Creates all ancestors of the given {@link IEntity} inside the
	 * repository if they don't already exist.
	 *
	 * @throws RepositoryWriteException
	 *             the repository write exception
	 */
	protected void createAncestorsIfMissing() throws RepositoryWriteException {
		final ICollection parent = getParent();
		if ((parent != null) && (!parent.exists())) {
			parent.create();
		}
	}

	/**
	 * Creates all ancestors of the given {@link IEntity} and itself too if
	 * they don't already exist.
	 *
	 * @throws RepositoryWriteException
	 *             the repository write exception
	 */
	protected void createAncestorsAndSelfIfMissing() throws RepositoryWriteException {
		createAncestorsIfMissing();
		if (!exists()) {
			create();
		}
	}

	/*
	 * (non-Javadoc)
	 * @see java.lang.Object#equals(java.lang.Object)
	 */
	@Override
	public boolean equals(Object obj) {
		if (obj == null) {
			return false;
		}
		if (obj == this) {
			return true;
		}
		if (!(obj instanceof LocalEntity)) {
			return false;
		}
		final LocalEntity other = (LocalEntity) obj;
		return getPath().equals(other.getPath());
	}

	/*
	 * (non-Javadoc)
	 * @see java.lang.Object#hashCode()
	 */
	@Override
	public int hashCode() {
		return getPath().hashCode();
	}

}