Package org.apache.uima.util

Class TypeSystemUtil

java.lang.Object
org.apache.uima.util.TypeSystemUtil
public class TypeSystemUtil extends Object

  • Constructor Details

    • TypeSystemUtil

      public TypeSystemUtil()

  • Method Details

    • loadTypeSystemDescriptionsFromClasspath

      public static List<TypeSystemDescription> loadTypeSystemDescriptionsFromClasspath(Class<?> aContext, String... aLocations)
      Loads type system descriptions and resolves their imports. For example when you place a TypeSystemDescriptionProvider implementation and place the type system descriptions it should provide in the same package, you can use this method to conveniently load them simply by name in the provider implementation. 
       public class MyTypeSystemDescriptionProvider implements TypeSystemDescriptionProvider {
   @Override
   public List<TypeSystemDescription> listTypeSystemDescriptions() {
     return TypeSystemUtil.loadTypeSystemDescriptionsFromClasspath(getClass(), "TypeSystem1.xml",
             "TypeSystem2.xml");
   }
 }
      Parameters:
      aContext - a context class. If the locations are not absolute, then they are looked up relative to this context class as per Class.getResource(String).
      aLocations - type system description locations to load.
      Returns:
      list of the loaded and resolved descriptions.

    • loadTypePrioritiesFromClasspath

      public static List<TypePriorities> loadTypePrioritiesFromClasspath(Class<?> aContext, String... aLocations)
      Loads type priorities and resolves their imports. For example when you place a TypePrioritiesProvider implementation and place the type priorities it should provide in the same package, you can use this method to conveniently load them simply by name in the provider implementation. 
       public class MyTypePrioritiesProvider implements TypePrioritiesProvider {
   @Override
   public List<TypePriorities> listTypePriorities() {
     return TypeSystemUtil.loadTypePrioritiesFromClasspath(getClass(), "TypePriorities1.xml",
             "TypePriorities2.xml");
   }
 }
      Parameters:
      aContext - a context class. If the locations are not absolute, then they are looked up relative to this context class as per Class.getResource(String).
      aLocations - type priorities locations to load.
      Returns:
      list of the loaded and resolved descriptions.

    • loadFsIndexCollectionsFromClasspath

      public static List<FsIndexCollection> loadFsIndexCollectionsFromClasspath(Class<?> aContext, String... aLocations)
      Loads FS index collections and resolves their imports. For example when you place a FsIndexCollectionProvider implementation and place the FS index collections it should provide in the same package, you can use this method to conveniently load them simply by name in the provider implementation. 
       public class MyFsIndexCollectionProvider implements FsIndexCollectionProvider {
   @Override
   public List<FsIndexCollection> listFsIndexCollections() {
     return TypeSystemUtil.loadFsIndexCollectionsFromClasspath(getClass(), "FsIndexCollection1.xml",
             "FsIndexCollection2.xml");
   }
 }
      Parameters:
      aContext - a context class. If the locations are not absolute, then they are looked up relative to this context class as per Class.getResource(String).
      aLocations - FS index collections locations to load.
      Returns:
      list of the loaded and resolved descriptions.

    • typeSystem2TypeSystemDescription

      public static TypeSystemDescription typeSystem2TypeSystemDescription(TypeSystem aTypeSystem)
      Convert a TypeSystem to an equivalent TypeSystemDescription.
      Parameters:
      aTypeSystem - type system object to convert
      Returns:
      a TypeSystemDescription that is equivalent to aTypeSystem

    • type2TypeDescription

      public static TypeDescription type2TypeDescription(Type aType, TypeSystem aTypeSystem)
      Convert a Type to an equivalent TypeDescription.
      Parameters:
      aType - type object to convert
      aTypeSystem - the TypeSystem that contains aType
      Returns:
      a TypeDescription that is equivalent to aType

    • feature2FeatureDescription

      public static FeatureDescription feature2FeatureDescription(Feature aFeature)
      Convert a Feature to an equivalent FeatureDescription.
      Parameters:
      aFeature - feature object to convert
      Returns:
      a FeatureDescription that is equivalent to aFeature

    • getAllowedValuesForType

      public static String[] getAllowedValuesForType(Type aType, TypeSystem aTypeSystem)
      Gets the allowed values for a string subtype.
      Parameters:
      aType - the type, which must be a subtype of uima.cas.String
      aTypeSystem - the type system to use
      Returns:
      array of allowed values for aType TODO - this should be a method on Type.

    • isFeatureName

      public static boolean isFeatureName(String name)
      Parameters:
      name - The name to check.
      Returns:
      if the given name is a valid feature name. Does not check if the feature actually exists!

    • isTypeName

      public static boolean isTypeName(String name)
      Check if name is a possible type name. Does not check if this type actually exists!
      Parameters:
      name - The name to check.
      Returns:
      true iff name is a possible type name.