jadex.bridge.IComponentIdentifier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jadex-platform-bridge Show documentation

Jadex bridge is a base package for kernels and platforms, i.e., it is used by both and provides commonly used interfaces and classes for active components and their management.

There is a newer version: 4.0.267

Show newest version

package jadex.bridge;


/**
 *  Interface for component identifiers.
 */
public interface IComponentIdentifier
{
	//-------- constants --------
	
	/** The constant to fetch the component id out of the results of a component. */
	public static final String RESULTCID = "__internal__component__identifier";
	
	/** The currently executing component (if any). */
	public static final ThreadLocal	LOCAL	= new ThreadLocal();
	
	/** The caller of a currently executed service call (if any). */
//	public static final ThreadLocal	CALLER	= new ThreadLocal();
	
	/** Return value for empty arrays. */
	public static final IComponentIdentifier[] EMPTY_COMPONENTIDENTIFIERS = new IComponentIdentifier[0];
	
	//-------- methods --------
	
	/**
	 *  Get the component name.
	 *  @return The name of an component.
	 */
	public String getName();
	
	/**
	 *  Get the local component name.
	 *  @return The local name of an component.
	 */
	public String getLocalName();
	
	/**
	 *  Get the platform name.
	 *  @return The platform name.
	 */
	public String getPlatformName();
	
	/**
	 *  Get the platform name without the suffix for name uniqueness.
	 *  @return The platform name without suffix.
	 */
	public String getPlatformPrefix();
	
	/**
	 *  Get the parent identifier.
	 *  @return The parent identifier (if any).
	 */
	public IComponentIdentifier getParent();
	
	/**
	 *  Get the root identifier.
	 *  @return The root identifier.
	 */
	public IComponentIdentifier getRoot();
	
	/**
	 *  Get the dot name.
	 *  @return The dot name.
	 */
	public String getDotName();
	
	/**
	 *  Test if this identifier has the same root as the cid.
	 *  @param cid The component id.
	 *  @return True, if the root is equal.
	 */
	public boolean hasSameRoot(IComponentIdentifier cid);
	
//	/**
//	 *  Get the application name. Equals the local component name in case it is a child of the platform.
//	 *  [email protected] -> awa
//	 *  @return The application name.
//	 */
//	public String getApplicationName();
}