Class TypeSystemProvider_ImplBase

java.lang.Object

org.apache.uima.spi.TypeSystemProvider_ImplBase

All Implemented Interfaces:

FsIndexCollectionProvider, JCasClassProvider, TypePrioritiesProvider, TypeSystemDescriptionProvider, TypeSystemProvider

public abstract class TypeSystemProvider_ImplBase
extends Object
implements TypeSystemProvider

Constructor Summary

Constructors

Constructor	Description
TypeSystemProvider_ImplBase()

Method Summary

Modifier and Type	Method	Description
Optional<URL>	findResourceUrl(String aName)	Returns the URL for a resource exported by this provider by name.
List<FsIndexCollection>	listFsIndexCollections()
List<Class<? extends TOP>>	listJCasClasses()
List<TypePriorities>	listTypePriorities()
List<TypeSystemDescription>	listTypeSystemDescriptions()
protected void	setFsIndexCollectionLocations(String... aLocations)
protected void	setTypePrioritiesLocations(String... aLocations)
protected void	setTypeSystemLocations(String... aLocations)

Methods inherited from class Object

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

Constructor Details

TypeSystemProvider_ImplBase

public TypeSystemProvider_ImplBase()

Method Details

setTypeSystemLocations

protected void setTypeSystemLocations(String... aLocations)

listTypeSystemDescriptions

public List<TypeSystemDescription> listTypeSystemDescriptions()

Specified by:

listTypeSystemDescriptions in interface TypeSystemDescriptionProvider

Specified by:

listTypeSystemDescriptions in interface TypeSystemProvider

Returns:

the type system descriptions exported by this provider. The provider should resolve any imports in these before returning them. If possible, the provider should internally cache the parsed type systems instead of parsing them on every call to this method.

setFsIndexCollectionLocations

protected void setFsIndexCollectionLocations(String... aLocations)

listFsIndexCollections

public List<FsIndexCollection> listFsIndexCollections()

Specified by:

listFsIndexCollections in interface FsIndexCollectionProvider

Specified by:

listFsIndexCollections in interface TypeSystemProvider

Returns:

the FS index collections exported by this provider. The provider should resolve any imports in these before returning them. If possible, the provider should internally cache the parsed type systems instead of parsing them on every call to this method.

setTypePrioritiesLocations

protected void setTypePrioritiesLocations(String... aLocations)

listTypePriorities

public List<TypePriorities> listTypePriorities()

Specified by:

listTypePriorities in interface TypePrioritiesProvider

Specified by:

listTypePriorities in interface TypeSystemProvider

Returns:

the type priorities exported by this provider. The provider should resolve any imports in these before returning them. If possible, the provider should internally cache the parsed type systems instead of parsing them on every call to this method.

findResourceUrl

public Optional<URL> findResourceUrl(String aName)

Description copied from interface: TypeSystemProvider

Returns the URL for a resource exported by this provider by name. This is necessary if any descriptors outside of this provider import resources owned by this provider by name. Note that by convention, any descriptors returned by this provide via TypeSystemProvider.listTypeSystemDescriptions(), TypeSystemProvider.listTypePriorities() and TypeSystemProvider.listFsIndexCollections() should already have resolved their imports, so for these methods to access local imports, implementing this method is not required.

Specified by:

findResourceUrl in interface TypeSystemProvider

Parameters:

aName - the name of the type system. This should be something like some.package.TypeSystem just as you would put it into the Import.setName(String) of a Import for a name-based import.

Returns:

the type system description(s) exported from the given location. The provider should resolve any imports in the type systems before returning them.

listJCasClasses

public List<Class<? extends TOP>> listJCasClasses()

Specified by:

listJCasClasses in interface JCasClassProvider

Specified by:

listJCasClasses in interface TypeSystemProvider

Returns:

the JCas classes exported by this provider. The provider should only supply JCas classes for types it exports via TypeSystemProvider.listTypeSystemDescriptions(). If possible, the provider should internally cache the parsed type systems instead of parsing them on every call to this method.