- All Implemented Interfaces:
public enum LayerViewStatus extends java.lang.Enum<LayerViewStatus>The status of a layer in the
This status is used to determine if a layer is displaying in a
GeoViewor whether it is still loading, not visible, out of scale, or has encountered an error or warning. Each layer can have multiple states at the same time. For example, a layer could be both
OUT_OF_SCALEor it could be
LOADING. These multiple states are represented using a flag enumeration.
A status of
ACTIVEindicates that the layer is displayed in the view. Note that some of the layer view states are not possible together. For example, a layer cannot be both
NOT_VISIBLEat the same time.
If you implement a layer list in a table of contents (TOC), you can use the layer view status to manage the TOC user interface. For example, you could gray out the layer if it is
OUT_OF_SCALE, or you could show a spinning icon if the layer is
LOADING. If the layer list contains a
NOT_VISIBLE, then its child layers will be
NOT_VISIBLE. If the
GroupLayeris visible, then each child layer can be either visible or
If the layer completely fails to load or render you will encounter a
ERROR. If the layer fails to render some of its content, then you will encounter a
WARNING. This could be due to the temporary loss of a network connection, failing layer requests or exceeding the max feature count. In both cases you will find more details about the problem by calling
Enum Constant Summary
Enum Constants Enum Constant Description
ACTIVEThe layer in the view is active.
ERRORThe layer in the view has an unrecoverable error.
LOADINGThe layer in the view is loading.
NOT_VISIBLEThe layer in the view is not visible.
OUT_OF_SCALEThe layer in the view is out of scale.
WARNINGThe layer in the view has encountered an error which may be temporary.
All Methods Static Methods Concrete Methods Modifier and Type Method Description
valueOf(java.lang.String name)Returns the enum constant of this type with the specified name.
values()Returns an array containing the constants of this enum type, in the order they are declared.
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
Enum Constant Detail
public static final LayerViewStatus ACTIVEThe layer in the view is active. A status of
ACTIVEindicates that the layer is being displayed in the view. This status can be combined with
public static final LayerViewStatus NOT_VISIBLEThe layer in the view is not visible.
public static final LayerViewStatus OUT_OF_SCALEThe layer in the view is out of scale. A status of
LayerViewStatus.OUT_OF_SCALEindicates that the view is zoomed outside of the scale range of the layer. If the view is zoomed too far in (e.g. to a street level), it is beyond the max scale defined for the layer. If the view has zoomed too far out (e.g. to global scale), it is beyond the min scale defined for the layer.
public static final LayerViewStatus LOADINGThe layer in the view is loading. Once loading has completed, the layer will be available for display in the view. If there was a problem loading the layer, the status will be set to
ERRORproperty will provide details on the specific problem.
public static final LayerViewStatus ERRORThe layer in the view has an unrecoverable error. When the status is
ERROR, the layer cannot be rendered in the view. For example, it may have failed to load, be an unsupported layer type, or contain invalid data.
ERRORproperty will provide more details about the specific problem which was encountered. Depending on the type of problem, you could try the following:
public static final LayerViewStatus WARNINGThe layer in the view has encountered an error which may be temporary. When the status is
WARNING, the layer may still be displayed in the view. It is possible for the status to be both
A warning status indicates that the layer has encountered a problem but may still be usable. For example, some tiles or features may be failing to load due to network failure or server error. You should be aware that when a
WARNINGis received, the layer may not be showing all data or it may be showing data which is not up-to-date. The
ERRORproperty will provide more details about the specific problem which was encountered.
Depending on the type of problem, you could:
- Check your network connection
- Check whether an online service is experiencing problems
public static LayerViewStatus values()Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (LayerViewStatus c : LayerViewStatus.values()) System.out.println(c);
- an array containing the constants of this enum type, in the order they are declared
public static LayerViewStatus valueOf(java.lang.String name)Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
name- the name of the enum constant to be returned.
- the enum constant with the specified name
java.lang.IllegalArgumentException- if this enum type has no constant with the specified name
java.lang.NullPointerException- if the argument is null