com.mapquest
Class AutoMapCovSwitch

java.lang.Object
  extended bycom.mapquest.MQObject
      extended bycom.mapquest.AutoMapCovSwitch
All Implemented Interfaces:
java.lang.Cloneable

public class AutoMapCovSwitch
extends MQObject

Stores map coverage switching parameters. Add this object to a Session to enable automatic map coverage switching for the session.

See Also:
IntCollection

Field Summary
static int CLASS_ID
           
static java.lang.String CLASS_NAME
           
static int nDataVendorCode_AND
          Deprecated. Use DataVendorCode.AND instead.
static int nDataVendorCode_CA
          Deprecated. Use DataVendorCode.CA instead.
static int nDataVendorCode_CRITCHLOW
          Deprecated. Use DataVendorCode.CRITCHLOW instead.
static int nDataVendorCode_DMTI
          Deprecated. Use DataVendorCode.DMTI instead.
static int nDataVendorCode_ETAK
          Deprecated. Use DataVendorCode.ETAK instead.
static int nDataVendorCode_GDT
          Deprecated. Use DataVendorCode.GDT instead.
static int nDataVendorCode_LEADDOG
          Deprecated. Use DataVendorCode.LEADDOG instead.
static int nDataVendorCode_MQ
          Deprecated. Use DataVendorCode.MQ instead.
static int nDataVendorCode_NT
          Deprecated. Use DataVendorCode.NT instead.
static int nDataVendorCode_TA
          Deprecated. Use DataVendorCode.TA instead.
static int nDataVendorCode_TIGER
          Deprecated. Use DataVendorCode.TIGER instead.
static int nDataVendorCode_UNKNOWN
          Deprecated. Use DataVendorCode.UNKNOWN instead.
static int nDataVendorCode_VOYAGER
          Deprecated. Use DataVendorCode.VOYAGER instead.
static int nDataVendorCodeUsage_Exclude
          Deprecated. Use DataVendorCode.USAGE_EXCLUDE instead.
static int nDataVendorCodeUsage_Include
          Deprecated. Use DataVendorCode.USAGE_INCLUDE instead.
 
Fields inherited from class com.mapquest.MQObject
DEFAULT_ID, DEFAULT_NAME, DEFAULT_VERSION, FORMAT_NUMERIC_ID, FORMAT_TEXT_NAME, INVALID_ID, INVALID_NAME, INVALID_VERSION
 
Constructor Summary
AutoMapCovSwitch()
           
 
Method Summary
 boolean equals(java.lang.Object otherObject)
          Compares this object to the specified object.
 int getClassId()
          Returns the numeric id of this class.
 java.lang.String getClassName()
          Returns the text name of this class.
 IntCollection getDataVendorCodes()
          Returns a collection of map data vendor codes.
 long getDataVendorCodeUsage()
          Gets the vendor name usage.
 java.lang.String getName()
          Gets the name of the coverage switching rules being used.
 java.lang.String getStyle()
          Gets the name of the style alias to be selected for the selected mapping coverage or blank for default.
 IntCollection getZoomLevels()
          Returns a reference to the collection of zoom level scales.
 int hashCode()
          Returns a hash code for this AutoMapCovSwitch.
 void init()
          Initializes object.
 void setDataVendorCodeUsage(long nDataVendorCodeUsage)
          Sets the data vendor code usage, which specifies how the vendor codes listed in getDataVendorCodes() are to be used.
 void setName(java.lang.String strName)
          Sets the name of the coverage switching rules to use.
 void setStyle(java.lang.String strStyle)
          Sets the name of the style alias to be selected for the selected mapping coverage or blank for default.
 
Methods inherited from class com.mapquest.MQObject
clone, getFormat, getIdWithVersion, getNameWithVersion, getObjectVersion, getTypeId, getTypeName, getVerboseConsoleOutput, setFormat, setObjectVersion, setVerboseConsoleOutput, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS_ID

public static final int CLASS_ID
See Also:
Constant Field Values

CLASS_NAME

public static final java.lang.String CLASS_NAME
See Also:
Constant Field Values

nDataVendorCodeUsage_Include

public static final int nDataVendorCodeUsage_Include
Deprecated. Use DataVendorCode.USAGE_INCLUDE instead.

See Also:
Constant Field Values

nDataVendorCodeUsage_Exclude

public static final int nDataVendorCodeUsage_Exclude
Deprecated. Use DataVendorCode.USAGE_EXCLUDE instead.

See Also:
Constant Field Values

nDataVendorCode_UNKNOWN

public static final int nDataVendorCode_UNKNOWN
Deprecated. Use DataVendorCode.UNKNOWN instead.

See Also:
Constant Field Values

nDataVendorCode_NT

public static final int nDataVendorCode_NT
Deprecated. Use DataVendorCode.NT instead.

See Also:
Constant Field Values

nDataVendorCode_GDT

public static final int nDataVendorCode_GDT
Deprecated. Use DataVendorCode.GDT instead.

See Also:
Constant Field Values

nDataVendorCode_DMTI

public static final int nDataVendorCode_DMTI
Deprecated. Use DataVendorCode.DMTI instead.

See Also:
Constant Field Values

nDataVendorCode_MQ

public static final int nDataVendorCode_MQ
Deprecated. Use DataVendorCode.MQ instead.

See Also:
Constant Field Values

nDataVendorCode_CA

public static final int nDataVendorCode_CA
Deprecated. Use DataVendorCode.CA instead.

See Also:
Constant Field Values

nDataVendorCode_TIGER

public static final int nDataVendorCode_TIGER
Deprecated. Use DataVendorCode.TIGER instead.

See Also:
Constant Field Values

nDataVendorCode_ETAK

public static final int nDataVendorCode_ETAK
Deprecated. Use DataVendorCode.ETAK instead.

See Also:
Constant Field Values

nDataVendorCode_TA

public static final int nDataVendorCode_TA
Deprecated. Use DataVendorCode.TA instead.

See Also:
Constant Field Values

nDataVendorCode_AND

public static final int nDataVendorCode_AND
Deprecated. Use DataVendorCode.AND instead.

See Also:
Constant Field Values

nDataVendorCode_VOYAGER

public static final int nDataVendorCode_VOYAGER
Deprecated. Use DataVendorCode.VOYAGER instead.

See Also:
Constant Field Values

nDataVendorCode_CRITCHLOW

public static final int nDataVendorCode_CRITCHLOW
Deprecated. Use DataVendorCode.CRITCHLOW instead.

See Also:
Constant Field Values

nDataVendorCode_LEADDOG

public static final int nDataVendorCode_LEADDOG
Deprecated. Use DataVendorCode.LEADDOG instead.

See Also:
Constant Field Values
Constructor Detail

AutoMapCovSwitch

public AutoMapCovSwitch()
Method Detail

init

public void init()
Initializes object.

Overrides:
init in class MQObject

getClassId

public int getClassId()
Returns the numeric id of this class.

Overrides:
getClassId in class MQObject
Returns:
the numeric id of this class.

getClassName

public java.lang.String getClassName()
Returns the text name of this class.

Overrides:
getClassName in class MQObject
Returns:
the text name of this class.

setName

public void setName(java.lang.String strName)
Sets the name of the coverage switching rules to use. Names of coverage switching rules are defined in the mqserver.ini file.

Parameters:
strName - Name of coverage switching rules to use.

getName

public java.lang.String getName()
Gets the name of the coverage switching rules being used.

Returns:
Name

getDataVendorCodes

public IntCollection getDataVendorCodes()
Returns a collection of map data vendor codes.

Returns:
IntCollection of vendor codes.

setDataVendorCodeUsage

public void setDataVendorCodeUsage(long nDataVendorCodeUsage)
Sets the data vendor code usage, which specifies how the vendor codes listed in getDataVendorCodes() are to be used. If set to nDataVendorCodeUsage_Include, the coverage switching algorithm will only consider coverages with vendor codes listed in DataVendorCodes. If set to nDataVendorCodeUsage_Exclude, all coverages will be considered EXCEPT those with vendor codes listed in DataVendorCodes.

Parameters:
nDataVendorCodeUsage - a DataVendorCodeUsage_ flag

getDataVendorCodeUsage

public long getDataVendorCodeUsage()
Gets the vendor name usage.

Returns:
a DataVendorCodeUsage_ flag

getZoomLevels

public IntCollection getZoomLevels()
Returns a reference to the collection of zoom level scales. These scales are used by the ZoomIn and ZoomOut map commands when coverage switching is enabled.

Returns:
IntCollection of zoom levels.

getStyle

public java.lang.String getStyle()
Gets the name of the style alias to be selected for the selected mapping coverage or blank for default.

Returns:
Style Alias

setStyle

public void setStyle(java.lang.String strStyle)
Sets the name of the style alias to be selected for the selected mapping coverage or blank for default.

Parameters:
strStyle - Style Alias

equals

public boolean equals(java.lang.Object otherObject)
Compares this object to the specified object. The result is true if and only if the argument is not null and is a AutoMapCovSwitch object that has same attributes as this object.

Overrides:
equals in class MQObject
Parameters:
otherObject - the object to compare this AutoMapCovSwitch against.
Returns:
true if the AutoMapCovSwitch objects are equal; false otherwise.

hashCode

public int hashCode()
Returns a hash code for this AutoMapCovSwitch.

Overrides:
hashCode in class MQObject
Returns:
a hash code value for this AutoMapCovSwitch.