Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.doc.user.examples.internal.extension
Class ExampleProject

java.lang.Object
  extended by eu.esdihumboldt.hale.doc.user.examples.internal.extension.ExampleProject
All Implemented Interfaces:
de.cs3d.util.eclipse.extension.simple.IdentifiableExtension.Identifiable, Comparable<ExampleProject>

public class ExampleProject
extends Object
implements de.cs3d.util.eclipse.extension.simple.IdentifiableExtension.Identifiable, Comparable<ExampleProject>

Represents a declared example project

Author:
Simon Templer

Constructor Summary
ExampleProject(String id, org.eclipse.core.runtime.IConfigurationElement conf)
          Create an example project from a configuration element.
 
Method Summary
 int compareTo(ExampleProject o)
           
 URI getAlignmentLocation()
          Get the location of the alignment file.
 String getBundleName()
          Get the name of the bundle the example project is contained in.
 String getId()
           
 ProjectInfo getInfo()
          Get the example project info
 String getLocation()
          Get the location of the project in its bundle.
 String getSummary()
          Get the example project summary.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExampleProject

public ExampleProject(String id,
                      org.eclipse.core.runtime.IConfigurationElement conf)
               throws URISyntaxException,
                      IOProviderConfigurationException,
                      IOException
Create an example project from a configuration element.

Parameters:
id - the project identifier
conf - the configuration element
Throws:
URISyntaxException - if the project location can't be resolved to a valid URI
IOException - if reading the project information fails
IOProviderConfigurationException - if the project reader wasn't configured correctly
Method Detail

compareTo

public int compareTo(ExampleProject o)
Specified by:
compareTo in interface Comparable<ExampleProject>
See Also:
Comparable.compareTo(Object)

getId

public String getId()
Specified by:
getId in interface de.cs3d.util.eclipse.extension.simple.IdentifiableExtension.Identifiable
See Also:
IdentifiableExtension.Identifiable.getId()

getInfo

public ProjectInfo getInfo()
Get the example project info

Returns:
the project info

getBundleName

public String getBundleName()
Get the name of the bundle the example project is contained in.

Returns:
the name of the bundle containing the project

getSummary

public String getSummary()
Get the example project summary.

Returns:
the summary

getLocation

public String getLocation()
Get the location of the project in its bundle.

Returns:
the bundle location as path inside the bundle that contains it

getAlignmentLocation

public URI getAlignmentLocation()
Get the location of the alignment file.

Returns:
the alignmentFile

Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d