Package com.luciad.format.vpf

Class TLcdVPFGeoSymProvider

java.lang.Object
com.luciad.format.vpf.TLcdVPFGeoSymProvider
All Implemented Interfaces:
com.luciad.internal.format.vpf.ILcdVPFStyleProvider
public class TLcdVPFGeoSymProvider extends Object implements com.luciad.internal.format.vpf.ILcdVPFStyleProvider
Used internally to retrieve a set of rules on how to represent VPF data using the GeoSym symbology. In order for your application to find the necessary files needed for this, you can either place them in the classpath (see manual) or set absolute or relative paths to them with static methods defined in this class.

  • Method Details

    • setClassTrace

      public static void setClassTrace(boolean aClassTrace)
      Enables logging on all instances of this class.
      Parameters:
      aClassTrace - boolean indicating whether logging should be enabled for instances of this class.

    • setFullSymPath

      public static void setFullSymPath(String aFullSymPath)
      Sets the location of the FULLSYM.TXT file. This location is ignored when using a Geosym version other than 1.4.
      Parameters:
      aFullSymPath - The location of the FULLSYM.TXT file.

    • setAttexpPath

      public static void setAttexpPath(String aAttexpPath)
      Sets the location of the ATTEXP.TXT file.
      Parameters:
      aAttexpPath - The location of the ATTEXP.TXT file.

    • setCodePath

      public static void setCodePath(String aCodePath)
      Sets the location of the CODE.TXT file.
      Parameters:
      aCodePath - The location of the CODE.TXT file.

    • setTextPath

      public static void setTextPath(String aTextPath)
      Sets the location of the TEXT.TXT file.
      Parameters:
      aTextPath - The location of the TEXT.TXT file.

    • setColorPath

      public static void setColorPath(String aColorPath)
      Sets the location of the COLOR.TXT file.
      Parameters:
      aColorPath - The location of the COLOR.TXT file.

    • setIconPath

      public static void setIconPath(String aIconPath)
      Sets the location of the IMS icons (the directory in which all icons are found).
      Parameters:
      aIconPath - The location of the IMS icons, terminated by a separator character (for example '/').

    • getInstance

      public static TLcdVPFGeoSymProvider getInstance(String aGeoSymProductId)
      Returns a TLcdVPFGeoSymProvider instance, initialized with the given GeoSym style for the given product type.
      Parameters:
      aGeoSymProductId - the GeoSym product type for which to return a GeoSym provider.
      Returns:
      a TLcdVPFGeoSymProvider instance, initialized with the given GeoSym style for the given product type.

    • getPointIcon

      public ILcdIcon getPointIcon(ILcdVPFFACCFeature aFeature)
      Returns the GeoSym icon that is used to represent the given FACC feature.
      Specified by:
      getPointIcon in interface com.luciad.internal.format.vpf.ILcdVPFStyleProvider
      Parameters:
      aFeature - the VPF feature for which to return a style
      Returns:
      an icon representing the given feature, or null if no icon is available for the given feature.

    • getLineIcon

      public ILcdIcon getLineIcon(ILcdVPFFACCFeature aFeature)
      Returns a TLcdVectorIcon; its getDefaultLineColor() method returns the GeoSym color that is used to represent this feature.
      Specified by:
      getLineIcon in interface com.luciad.internal.format.vpf.ILcdVPFStyleProvider
      Parameters:
      aFeature - the VPF feature for which to return a style
      Returns:
      an icon representing the given feature, or null if no icon is available for the given feature.

    • getAreaPointIcon

      public ILcdIcon getAreaPointIcon(ILcdVPFFACCFeature aFeature)
      Specified by:
      getAreaPointIcon in interface com.luciad.internal.format.vpf.ILcdVPFStyleProvider

    • getAreaLineIcon

      public ILcdIcon getAreaLineIcon(ILcdVPFFACCFeature aFeature)
      Returns a TLcdVectorIcon; its getDefaultLineColor() method returns the GeoSym color that is used to represent the outline of this feature.
      Specified by:
      getAreaLineIcon in interface com.luciad.internal.format.vpf.ILcdVPFStyleProvider
      Parameters:
      aFeature - the VPF feature for which to return a style
      Returns:
      an icon representing the given feature, or null if no icon is available for the given feature.

    • getAreaFillIcon

      public ILcdIcon getAreaFillIcon(ILcdVPFFACCFeature aFeature)
      Returns a TLcdVectorIcon; its getDefaultLineColor() method returns the GeoSym color that is used to represent the filled area of this feature.
      Specified by:
      getAreaFillIcon in interface com.luciad.internal.format.vpf.ILcdVPFStyleProvider
      Parameters:
      aFeature - the VPF feature for which to return a style
      Returns:
      an icon representing the given feature, or null if no icon is available for the given feature.

    • getPointSymbolIds

      public String[] getPointSymbolIds(ILcdVPFFACCFeature aFeature)
      Returns an array containing the symbol id's for all GeoSym rules that match the given point feature.
      Parameters:
      aFeature - a point feature for which to retrieve symbols id's.
      Returns:
      an array with all GeoSym symbol id's for the given point feature, or null if none were found.

    • getLineSymbolIds

      public String[] getLineSymbolIds(ILcdVPFFACCFeature aFeature)
      Returns an array containing the symbol id's for all GeoSym rules that match the given line feature.
      Parameters:
      aFeature - a line feature for which to retrieve symbols id's.
      Returns:
      an array with all GeoSym symbol id's for the given line feature, or null if none were found.

    • getAreaPointSymbolIds

      public String[] getAreaPointSymbolIds(ILcdVPFFACCFeature aFeature)
      Returns an array containing the point symbol id's for all GeoSym rules that match the given area feature.
      Parameters:
      aFeature - a area feature for which to retrieve point symbols id's.
      Returns:
      an array with all GeoSym point symbol id's for the given area feature, or null if none were found.

    • getAreaLineSymbolIds

      public String[] getAreaLineSymbolIds(ILcdVPFFACCFeature aFeature)
      Returns an array containing the line symbol id's for all GeoSym rules that match the given area feature.
      Parameters:
      aFeature - a area feature for which to retrieve line symbols id's.
      Returns:
      an array with all GeoSym line symbol id's for the given area feature, or null if none were found.

    • getAreaFillSymbolIds

      public String[] getAreaFillSymbolIds(ILcdVPFFACCFeature aFeature)
      Returns an array containing the fill symbol id's for all GeoSym rules that match the given area feature.
      Parameters:
      aFeature - a area feature for which to retrieve fill symbols id's.
      Returns:
      an array with all GeoSym fill symbol id's for the given area feature, or null if none were found.