org.eclipse.osbp.ecview.core.common/src/org/eclipse/osbp/ecview/core/common/uri/AccessibleScope.java

/**
 * Copyright (c) 2011, 2015 - Lunifera GmbH (Gross Enzersdorf, Austria), Loetz GmbH&Co.KG (69115 Heidelberg, Germany)
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0 
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *         Florian Pirchner - Initial implementation
 */
package org.eclipse.osbp.ecview.core.common.uri;

import java.net.URI;

import org.eclipse.osbp.ecview.core.common.IAccessible;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

// TODO: Auto-generated Javadoc
/**
 * The Class AccessibleScope.
 */
public abstract class AccessibleScope extends AbstractScope {

	/** The Constant logger. */
	private static final Logger logger = LoggerFactory
			.getLogger(AccessibleScope.class);

	/** The bean scope. */
	protected BeanScope beanScope;
	
	/** The service scope. */
	protected ServiceScope serviceScope;

	/**
	 * Instantiates a new accessible scope.
	 *
	 * @param schema
	 *            the schema
	 */
	protected AccessibleScope(String schema) {
		setURISegment(schema);
	}

	/**
	 * Replaces the fragment token that is used to access the bean in the slot.
	 * <p>
	 * For instance: <br>
	 * <code>value.person.address</code> will be changed to
	 * <code>person.address</code>
	 *
	 * @param beanFragment
	 *            the bean fragment
	 * @return the string
	 */
	public static String removeSlotValueFragmentToken(String beanFragment) {
		if (beanFragment.startsWith("value.")) {
			beanFragment = beanFragment.replaceFirst("value.", "");
		} else if (beanFragment.equals("value")) {
			beanFragment = "";
		}
		return beanFragment;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.osbp.ecview.core.common.uri.IURIScope#root()
	 */
	@SuppressWarnings("unchecked")
	@Override
	public <A extends AccessibleScope> A root() {
		return (A) this;
	}

	/**
	 * Returns an URI that points to the most deep element expressed in that
	 * scope.
	 *
	 * @return the uri
	 */
	public URI toFullURI() {
		if (beanScope != null) {
			FragmentScope fragmentScope = beanScope.getFragmentScope();
			return fragmentScope != null ? fragmentScope.toURI() : beanScope
					.toURI();
		} else if (serviceScope != null) {
			return serviceScope.toURI();
		}
		return null;
	}

	/**
	 * Returns the bean scope. If the scope does not have a bean scope then
	 * <code>null</code> is returned.
	 *
	 * @return the bean scope
	 */
	public BeanScope getBeanScope() {
		return beanScope;
	}

	/**
	 * Returns the service scope. If the scope does not have a service scope
	 * then <code>null</code> is returned.
	 *
	 * @return the service scope
	 */
	public ServiceScope getServiceScope() {
		return serviceScope;
	}

	/**
	 * Creates a bean scope for the given selector.
	 *
	 * @param selector
	 *            the selector
	 * @return the bean scope
	 */
	public BeanScope bean(String selector) {
		if (serviceScope != null) {
			logger.error("ServiceScope was already defined!");
		}
		// TODO check bean scope exists
		beanScope = new BeanScope(this, selector);
		return beanScope;
	}

	/**
	 * Creates a service scope for the given selector.
	 *
	 * @param selector
	 *            the selector
	 * @return the service scope
	 */
	public ServiceScope service(String selector) {
		if (beanScope != null) {
			logger.error("BeanScope was already defined!");
		}
		// TODO check bean scope exists
		serviceScope = new ServiceScope(this, selector);
		return serviceScope;
	}

	/**
	 * Accesses the object in the given context that is described by the uri of
	 * this scope.
	 *
	 * @param context
	 *            the context
	 * @return the object
	 */
	public abstract Object access(IAccessible context);

	/**
	 * Returns the URI representation of the bean scope string token if exists.
	 * Otherwise it returns 'null'
	 * 
	 * @return URI
	 */
	public URI toBeanURI() {
		return beanScope != null ? beanScope.toURI() : null;
	}

	/**
	 * Returns the URI representation of the bean fragment scope string token if
	 * exists. Otherwise it returns 'null'
	 * 
	 * @return URI
	 */
	public URI toBeanFragmentURI() {
		if (beanScope != null) {
			FragmentScope fragmentScope = beanScope.getFragmentScope();
			return fragmentScope != null ? fragmentScope.toURI() : null;
		}
		return null;
	}

	/**
	 * Returns the String representation of the fragment scope string token
	 * within the bean scope if exists. Otherwise it returns 'null'
	 * 
	 * @return URI
	 */
	public String getBeanFragment() {
		if (beanScope != null) {
			FragmentScope fragmentScope = beanScope.getFragmentScope();
			return fragmentScope != null ? fragmentScope.getFragmentContent()
					: "";
		}
		return "";
	}

	/**
	 * Returns the URI representation of the service scope string token if
	 * exists. Otherwise it returns 'null'
	 * 
	 * @return URI
	 */
	public URI toServiceURI() {
		return serviceScope != null ? serviceScope.toURI() : null;
	}

	/* (non-Javadoc)
	 * @see java.lang.Object#toString()
	 */
	public String toString() {
		return toFullURI().toString();
	}

}