info.textgrid.lab.core.model

Class ModelAdaptorFactory

java.lang.Object

info.textgrid.lab.core.model.ModelAdaptorFactory

All Implemented Interfaces:

IAdapterFactory

public class ModelAdaptorFactory
extends Object
implements IAdapterFactory

AdaptorFactory for converting between the various model layers.

Clients do not use this file directly, but call methods like TextGridObject#getAdapter(Object, Class) instead.

See Also:

TextGridObject, IAdaptable.getAdapter(Class)

Constructor Summary

Constructors

Constructor and Description
ModelAdaptorFactory()

Method Summary

Modifier and Type	Method and Description
protected static IFile	createFileFor(TextGridObject object) Returns an IFile for the given TextGridObject.
Object	getAdapter(Object adaptableObject, Class adapterType)
Class[]	getAdapterList()
protected static IFile	getFileFor(TextGridObject object, boolean createProject) Not API, please use getAdapter().
protected static IProject	getOpenProject(TextGridObject object, boolean createProject) Determines and opens the IProject in the current workspace where the resource for object will be placed in.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModelAdaptorFactory

public ModelAdaptorFactory()

Method Detail

getFileFor

protected static IFile getFileFor(TextGridObject object,
                                  boolean createProject)

Not API, please use getAdapter(). This helper method tries to get the IFile object for a given TextGridObject. If there already is a link in the workspace, it is returned. Otherwise the method may return an IFile that does not exist yet, or null.

Parameters:

object - the TextGridObject to get the file for. May not be null.

createProject - if true and the project does not exist yet, the project is created. Beware that this may be prone to scheduling issues.

Returns:

an IFile object representing this object, possibly without the link to the object.

Throws:

SchedulingException - if we can't create the project due to scheduling issues. Will never be thrown when createProject is false

createFileFor

protected static IFile createFileFor(TextGridObject object)

Returns an IFile for the given TextGridObject. If the IFile does not exist in the workspace yet, a link is created, use getFileFor(TextGridObject, boolean) if you don't want this.

This method is not intended for end-users: Use TextGridObject.getAdapter(IFile.class) instead.

getOpenProject

protected static IProject getOpenProject(TextGridObject object,
                                         boolean createProject)
                                  throws CoreException

Determines and opens the IProject in the current workspace where the resource for object will be placed in.

Parameters:

object - The TextGridObject for which a IProject should be returned

createProject - if the project does not exist yet, createProject determines what to do: If true, the project will be created and returned, if false, null will be returned.

Returns:

the IProject where the link for TextGridObject's IFile can be placed into, or null if the project doesn't exist and isn't created.

Throws:

CoreException - if something goes wrong, especially with accessing metadata.

SchedulingException - if we aren't allowed to perform neccessary workspace operations due to scheduling conflicts.

getAdapter

public Object getAdapter(Object adaptableObject,
                         Class adapterType)

Specified by:

getAdapter in interface IAdapterFactory

getAdapterList

public Class[] getAdapterList()

Specified by:

getAdapterList in interface IAdapterFactory