com.luciad.layers.grids.mgrs

Class MgrsGridSetting.Builder

java.lang.Object

com.luciad.layers.grids.mgrs.MgrsGridSetting.Builder

All Implemented Interfaces:

AutoCloseable

Enclosing class:

MgrsGridSetting

public static final class MgrsGridSetting.Builder
extends Object
implements AutoCloseable

Builder for a MGRS grid setting.

Since:

2023.1

Constructor Summary

Constructors

Constructor and Description
Builder(MgrsGridSetting.Builder other)

Method Summary

Modifier and Type	Method and Description
MgrsGridSetting	build() Returns the MGRS grid setting.
void	close()
protected void	finalize()
MgrsGridSetting.Builder	labelEdgeOffset(double labelEdgeOffset) This specifies the offset of the label, away from the edges of the view, in device independent pixels.
MgrsGridSetting.Builder	labelFormat(String labelFormat) The format pattern to use for the labels of the current MGRS.
MgrsGridSetting.Builder	labelGridOffset(double labelGridOffset) This specifies the offset of the label, in device independent pixels, away from the grid line to which it is attached.
MgrsGridSetting.Builder	labelOrientation(GridLabelOrientation labelOrientation) This specifies the label orientation with respect to the line.
MgrsGridSetting.Builder	labelPosition(GridLabelPosition labelPosition) This specifies the label position with respect to the view.
MgrsGridSetting.Builder	labelStyle(TextStyle labelStyle) Indicates the label style to use for this setting.
MgrsGridSetting.Builder	level(MgrsLevel level) Indicates the MGRS level for which this setting applies.
MgrsGridSetting.Builder	lineLabelPosition(GridLineLabelPosition lineLabelPosition) This specifies the label position (with respect to the line) to use for the line labels of the current MGRS type/level/interval combination.
MgrsGridSetting.Builder	lineStyle(LineStyle lineStyle) Indicates the line style to use for this setting.
MgrsGridSetting.Builder	scaleRange(MapScale minScale, MapScale maxScale) Indicates the scale range for which this setting applies.
MgrsGridSetting.Builder	type(MgrsType type) Indicates the MGRS type for which this setting applies.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(@NotNull
               MgrsGridSetting.Builder other)

Method Detail

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

build

@NotNull
public MgrsGridSetting build()
                               throws IllegalStateException

Returns the MGRS grid setting.

Mandatory parameters:

• level
• scale range

Other parameters are optional.

Returns:

the MGRS grid setting.

Throws:

IllegalStateException - when not all mandatory parameters are set.

level

@NotNull
public MgrsGridSetting.Builder level(@NotNull
                                              MgrsLevel level)

Indicates the MGRS level for which this setting applies.

This is mandatory.

Parameters:

level - the MGRS level.

Returns:

this builder.

type

@NotNull
public MgrsGridSetting.Builder type(@NotNull
                                             MgrsType type)

Indicates the MGRS type for which this setting applies.

This is optional. When not called this setting applies to both MGRS types.

Parameters:

type - the MGRS type.

Returns:

this builder.

scaleRange

@NotNull
public MgrsGridSetting.Builder scaleRange(@NotNull
                                                   MapScale minScale,
                                                   @NotNull
                                                   MapScale maxScale)
                                            throws IllegalArgumentException

Indicates the scale range for which this setting applies.

This is mandatory.

Parameters:

minScale - the min scale (most zoomed out).

maxScale - the max scale (most zoomed in).

Returns:

this builder.

Throws:

IllegalArgumentException - when the min scale is larger than or equal to the max scale.

lineStyle

@NotNull
public MgrsGridSetting.Builder lineStyle(@NotNull
                                                  LineStyle lineStyle)

Indicates the line style to use for this setting.

This is optional. Defaults to a white line style with width 1.

Parameters:

lineStyle - the line style.

Returns:

this builder.

labelStyle

@NotNull
public MgrsGridSetting.Builder labelStyle(@NotNull
                                                   TextStyle labelStyle)

Indicates the label style to use for this setting.

This is optional. Defaults to a white text style with font size 14 and a black halo.

Parameters:

labelStyle - the label style.

Returns:

this builder.

labelEdgeOffset

@NotNull
public MgrsGridSetting.Builder labelEdgeOffset(double labelEdgeOffset)
                                                 throws IllegalArgumentException

This specifies the offset of the label, away from the edges of the view, in device independent pixels.

It is applied for the labels of the current MGRS type/level/interval combination.

This is optional. Defaults to 6.

Parameters:

labelEdgeOffset - the edge offset value. Must be >= 0.

Returns:

this builder.

Throws:

IllegalArgumentException - when an invalid value is passed.

labelGridOffset

@NotNull
public MgrsGridSetting.Builder labelGridOffset(double labelGridOffset)
                                                 throws IllegalArgumentException

This specifies the offset of the label, in device independent pixels, away from the grid line to which it is attached.

It is applied for the labels of the current MGRS type/level/interval combination.

This is optional. Defaults to 3.

Parameters:

labelGridOffset - the grid offset value. Must be >= 0.

Returns:

this builder.

Throws:

IllegalArgumentException - when an invalid value is passed.

lineLabelPosition

@NotNull
public MgrsGridSetting.Builder lineLabelPosition(@NotNull
                                                          GridLineLabelPosition lineLabelPosition)

This specifies the label position (with respect to the line) to use for the line labels of the current MGRS type/level/interval combination.

They can for example be placed at the left or at the right of the line.

It is applied for the labels of the current MGRS type/level/interval combination.

This is optional. Defaults to AboveOrLeft.

Parameters:

lineLabelPosition - the line label position.

Returns:

this builder.

labelOrientation

@NotNull
public MgrsGridSetting.Builder labelOrientation(@NotNull
                                                         GridLabelOrientation labelOrientation)

This specifies the label orientation with respect to the line.

It is applied for the labels of the current MGRS type/level/interval combination.

This is optional. Defaults to AlongLine.

Parameters:

labelOrientation - the label orientation.

Returns:

this builder.

labelPosition

@NotNull
public MgrsGridSetting.Builder labelPosition(@NotNull
                                                      GridLabelPosition labelPosition)

This specifies the label position with respect to the view.

They can for example be placed at the left or at the right edge of the view. For example, when a label is placed at the east or south side of a line, it is placed at the left or lower edge of the view when using a rectangular projection like Mercator.

It is applied for the labels of the current MGRS type/level/interval combination.

This is optional. Defaults to WestAndSouth.

Parameters:

labelPosition - the label position.

Returns:

this builder.

labelFormat

@NotNull
public MgrsGridSetting.Builder labelFormat(@NotNull
                                                    String labelFormat)
                                             throws IllegalArgumentException

The format pattern to use for the labels of the current MGRS.

This pattern can be used to specify MGRS coordinates or UTM/UPS coordinates.

The format in BNF notation (expressions enclosed in [] brackets are optional, expressions enclosed in {} brackets may be omitted or repeated):

 <pattern>          ::= [<zone>] [<separator> <band>] [<coordinates>]
 <zone>             ::= "Z"
 <band>             ::= "B"
 <coordinates>      ::= <mgrs_coordinates> | <utm_coordinates>
 <mgrs_coordinates> ::= [<separator> <id100k>] [<separator> <x> <separator> <y>]
 <utm_coordinates>  ::= [<separator> <u> <separator> <v>]
 <id100k>           ::= "S"
 <x>                ::= "X" <mgrs_precision>
 <y>                ::= "Y" <mgrs_precision>
 <mgrs_precision>   ::= "0" | "1" | "2" | "3" | "4" | "5"
 <u>                ::= "U" <utm_precision>
 <v>                ::= "V" <utm_precision>
 <utm_precision>    ::= "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7"
 <separator>        ::= { ? any character ? }
 

For example:

• "33UES 12345 54321" has format "ZBS X5 Y5"
• "33U 123456 7654321" has format "ZB U6 V7"

Depending on the label, only some parts of the format string will be used. For example, when displaying grid line labels, only the X or Y part of the format string will be used (e.g. it can be used to specify if "12345" or "1234" is displayed).

It is applied for the labels of the current MGRS type/level/interval combination.

This is optional. When not specified a default label format is used, depending on the level.

Parameters:

labelFormat - the label format.

Returns:

this builder.

Throws:

IllegalArgumentException - when an invalid value is passed.