TGContentType

java.lang.Object
- info.textgrid.lab.core.model.TGContentType

All Implemented Interfaces:

Comparable<TGContentType>
```
public class TGContentType
extends Object
implements Comparable<TGContentType>
```
A (read-only) implementation for TextGrid content types.
New content types are contributed using the extension point info.textgrid.lab.core.contentTypes

How to register a new content type

To register a new content type, you need to define an extension to the extension point info.textgrid.lab.core.contentTypes. Open your plugin manifest, go to the Extensions tab, click add and select info.textgrid.lab.core.contentTypes. You can now right-click the corresponding entry and add a new contentType element. Select the element and hover the fields for a description of the individual values.

Some notes for specific fields:

Eclipse Content Type

The eclipse content type is used for eclipse specific handling like editor selecion etc. You should assign a type here. It may be useful to create a new eclipse content type (extension point org.eclipse.core.runtime.contentType) that is based on an existing content type for some applications (e.g., if you define a new XML format).

Extension

You need to define exactly one extension here. It will be used in some use cases, e.g., (1) as extension of the pseudo file that is used to represent the TextGridObjects of your type to Eclipse, (2) as file extension when exporting objects of your type, or (3) in the content type detection heuristics of the import wizard. The latter is a reason to not reuse the extension of another content type (don't use xml or I will change it), otherwise the heuristics just takes the first available content type.

Field Summary

Fields
Modifier and Type Field and Description

static String UNKNOWN_ID
A default type identifying unknown content types

Fields
Modifier and Type	Field and Description
`static String`	`UNKNOWN_ID` A default type identifying unknown content types

Constructor Summary

Constructors
Constructor and Description
`TGContentType(IConfigurationElement element)` Creates a content type from the extension point
`TGContentType(String id, String description, String extension, String additionalTypes, boolean internal, String eclipseContentType)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`compareTo(TGContentType contentType)` Compares this `TGContentType` with the specified `TGContentType` for order.
`static TGContentType`	`findByEclipseType(IContentType type)` Tries to find a suitable TextGrid content type for the given Eclipse content type
`static TGContentType`	`findByExtension(String extension)` Tries to find a matching content type the given file extension.
`static TGContentType`	`findMatchingContentType(String id)` Tries to find a content type for the given ID.
`Pattern`	`getAdditionalTypes()` Returns a pattern that matches additional content type strings that might describe this content type.
`static TGContentType`	`getByFilename(String filename)` Returns or creates a content type for the given file name.
`static TGContentType`	`getContentType(String id)` Returns the content type with the given id.
`static TGContentType[]`	`getContentTypes()` Deprecated. Use `getContentTypes(boolean)` instead
`static TGContentType[]`	`getContentTypes(boolean onlyPublic)` Returns a copy of the list of content types.
`static TGContentType[]`	`getContentTypes(com.google.common.base.Predicate<TGContentType> filter)` Returns a subset of content types.
`IContributor`	`getContributor()`
`static String`	`getDebugInfo()`
`String`	`getDescription()` Returns a human-readable description for this content type.
`IContentType`	`getEclipseContentType()`
`String`	`getEclipseContentTypeID()` Returns Eclipse's content type ID for this content type, if applicable
`String`	`getExtension()` Returns the file extension to append to link names of this content type
`String`	`getId()` Returns the content type's MIME id.
`Image`	`getImage(boolean fallback)` Returns an image representing the object.
`ImageDescriptor`	`getImageDescriptor()` Returns an image descriptor representing an icon for objects of this content type.
`boolean`	`isAdHoc()` A content type is an ad hoc content type if it has been automatically created from a file extension or from a content type id, without proper configuration from an extension point etc.
`boolean`	`isCreatable()` Returns whether the TextGridLab can create new objects of this content type.
`boolean`	`isInternal()` If true, files of this type are created internally by the lab and should not show up in the New dialog etc.
`boolean`	`isUnknown()` If true, this is the special content type representing unknown mime types.
`protected static void`	`loadContentTypes()`
`static TGContentType`	`of(String id)` Returns a content type for the given MIME type.
`protected void`	`setImageDescriptor(ImageDescriptor imageDescriptor)` Registers the given image descriptor for use with this content type.
`String`	`toDebugString(String delimiter)` Returns a debug string for the current object, containing of the following fields in order, delimited by the given delimiter: `getDescription()` `getId()` flags, if present: internal, creatable, ad-hoc, unknown `getExtension()` `getEclipseContentTypeID()` the contributing plugin's ID.
`String`	`toString()` Returns a human-readable string describing the content type.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - UNKNOWN_ID
```
public static final String UNKNOWN_ID
```
    A default type identifying unknown content types
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TGContentType
```
public TGContentType(String id,
                     String description,
                     String extension,
                     String additionalTypes,
                     boolean internal,
                     String eclipseContentType)
              throws CoreException
```
    Parameters:
    
    id - the MIME type, see getId()
    
    description - a human readable description, see getDescription()
    
    extension - TODO
    
    additionalPattern - TODO
    
    Throws:
    
    CoreException - when the content type could not be created.
  - TGContentType
```
public TGContentType(IConfigurationElement element)
              throws InvalidRegistryObjectException,
                     CoreException
```
    Creates a content type from the extension point
    
    Parameters:
    
    element -
    
    Throws:
    
    CoreException - When the content type could not be created.
    
    InvalidRegistryObjectException
- Method Detail
  - isCreatable
```
public boolean isCreatable()
```
    Returns whether the TextGridLab can create new objects of this content type.
  - isAdHoc
```
public boolean isAdHoc()
```
    A content type is an ad hoc content type if it has been automatically created from a file extension or from a content type id, without proper configuration from an extension point etc.
  - getExtension
```
public String getExtension()
```
    Returns the file extension to append to link names of this content type
  - getAdditionalTypes
```
public Pattern getAdditionalTypes()
```
    Returns a pattern that matches additional content type strings that might describe this content type. Used for legacy content types in the repository.
  - getId
```
public String getId()
```
    Returns the content type's MIME id.
  - getDescription
```
public String getDescription()
```
    Returns a human-readable description for this content type.
  - getEclipseContentTypeID
```
public String getEclipseContentTypeID()
```
    Returns Eclipse's content type ID for this content type, if applicable
  - getEclipseContentType
```
public IContentType getEclipseContentType()
```
  - isInternal
```
public boolean isInternal()
```
    If true, files of this type are created internally by the lab and should not show up in the New dialog etc.
  - getContributor
```
public IContributor getContributor()
```
    Returns:
    
    the bundle that contributed this content type.
  - getImageDescriptor
```
public ImageDescriptor getImageDescriptor()
```
    Returns an image descriptor representing an icon for objects of this content type.
    If the contributor specifies an image attribute in its extension, this image is used. Otherwise we try to find this object's default editor and use its icon.
    
    Clients might want to use getImage(boolean), which delivers an image managed by this plugin's ImageRegistry.
    
    Returns:
    
    an ImageDescriptor or null, if no appropriate icon could be found.
  - getImage
```
public Image getImage(boolean fallback)
```
    Returns an image representing the object. The image will be managed by this plugin's or the workbench's image resistry.
    
    Parameters:
    
    fallback - if true, return a default image if no image could be found.
    
    Returns:
    
    an Image or null, if none found and fallback is false.
    
    See Also:
    
    getImageDescriptor()
  - setImageDescriptor
```
protected void setImageDescriptor(ImageDescriptor imageDescriptor)
```
    Registers the given image descriptor for use with this content type.
    
    Parameters:
    
    imageDescriptor -
  - loadContentTypes
```
protected static void loadContentTypes()
```
  - getDebugInfo
```
public static String getDebugInfo()
```
  - getContentType
```
public static TGContentType getContentType(String id)
```
    Returns the content type with the given id.
    
    Parameters:
    
    id -
    
    Returns:
    
    The content type object or null, if none found.
    
    See Also:
    
    findMatchingContentType(String)
  - findMatchingContentType
```
public static TGContentType findMatchingContentType(String id)
```
    Tries to find a content type for the given ID. First it looks for content types with the given id in their ID field, if this is fruitless it looks for a pattern whose additional types pattern maches the given string.
    
    Parameters:
    
    id - A content type identifier.
    
    Returns:
    
    A matching content type or the unknown content type, if none found.
  - of
```
public static TGContentType of(String id)
                        throws IllegalArgumentException
```
    Returns a content type for the given MIME type. If a TGContentType with the given ID could be found in the registry, it is returned. Otherwise, we try to create an ad-hoc content type for the given and return that. If we create a new content type object, it is also added to the registry as non-creatable and ad-hoc.
    
    Parameters:
    
    id - a MIME type for which to return a TGContentType object
    
    Returns:
    
    a TGContentType for the given id, either as returned by findMatchingContentType(String) or created ad hoc.
    
    Throws:
    
    IllegalArgumentException
  - getContentTypes
```
@Deprecated
public static TGContentType[] getContentTypes()
```
    Deprecated. Use getContentTypes(boolean) instead
  - getContentTypes
```
public static TGContentType[] getContentTypes(boolean onlyPublic)
```
    Returns a copy of the list of content types.
    
    Parameters:
    
    onlyPublic - If true, internal content types are not included.
  - getContentTypes
```
public static TGContentType[] getContentTypes(com.google.common.base.Predicate<TGContentType> filter)
```
    Returns a subset of content types.
    
    Parameters:
    
    filter - a Predicate that returns true for each content type that should be returned
    
    Returns:
    
    those content types for which the filter returned true.
  - toString
```
public String toString()
```
    Returns a human-readable string describing the content type.
    
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()
  - isUnknown
```
public boolean isUnknown()
```
    If true, this is the special content type representing unknown mime types. You MUST NOT create objects with this type!
  - findByExtension
```
public static TGContentType findByExtension(String extension)
```
    Tries to find a matching content type the given file extension.
    Alternative
    If you have a file name and accept ad-hoc content types, use getByFilename(String) instead.
    
    Parameters:
    
    extension - the file extension, case insensitive without the leading dot. May not be null.
    
    Returns:
    
    A content type whose extension matches the given extension, or null if none found.
  - getByFilename
```
public static TGContentType getByFilename(String filename)
```
    Returns or creates a content type for the given file name. We're trying to find an existing content type from the content type registry:
    1. by calling findByExtension(String) on the filename's extension
    2. by asking the system's MIME type map (cf. MimetypesFileTypeMap) for the MIME type and searchiong for that in our registry.
    If we're unsuccessful, a new ContentType is created. We try to guess the new type's attributes. New types will be ad-hoc and not creatable. The new content type is added to the registry, it will be returned by future calls of getContentTypes(false) and considered in future calls of the content type retrieval methods.
    Parameters:
    
    filename - The name of the file for which we're looking for a content type.
    
    Returns:
    
    the content type object, possibly an ad-hoc one.
  - findByEclipseType
```
public static TGContentType findByEclipseType(IContentType type)
```
    Tries to find a suitable TextGrid content type for the given Eclipse content type
    
    Parameters:
    
    An - eclipse content type to look for
    
    Returns:
    
    a TGContentType that is associated with the given Eclipse content type or some parent type of that, or null.
  - toDebugString
```
public String toDebugString(String delimiter)
```
    Returns a debug string for the current object, containing of the following fields in order, delimited by the given delimiter:
    - getDescription()
    - getId()
    - flags, if present: internal, creatable, ad-hoc, unknown
    - getExtension()
    - getEclipseContentTypeID()
    - the contributing plugin's ID.
    Parameters:
    
    delimiter - string used to separate the fields.
  - compareTo
```
public int compareTo(TGContentType contentType)
```
    Compares this TGContentType with the specified TGContentType for order.
    
    Specified by:
    
    compareTo in interface Comparable<TGContentType>
    
    Parameters:
    
    contentType - the content type to be compared
    
    Returns:
    
    a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Class TGContentType

How to register a new content type

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNKNOWN_ID

Constructor Detail

TGContentType

TGContentType

Method Detail

isCreatable

isAdHoc

getExtension

getAdditionalTypes

getId

getDescription

getEclipseContentTypeID

getEclipseContentType

isInternal

getContributor

getImageDescriptor

getImage

setImageDescriptor

loadContentTypes

getDebugInfo

getContentType

findMatchingContentType

of

getContentTypes

getContentTypes

getContentTypes

toString

isUnknown

findByExtension

Alternative

getByFilename

findByEclipseType

toDebugString

compareTo