jain.protocol.ss7
Class GTIndicator0001

java.lang.Object
  |
  +--jain.protocol.ss7.GlobalTitle
        |
        +--jain.protocol.ss7.GTIndicator0001

All Implemented Interfaces:

java.io.Serializable

public final class GTIndicator0001

extends GlobalTitle

This class represents a Global Title Indicator-0001, it can be used to store, create and retrieve GlobalTitle-0001 entries. It contains the accessor methods for the following parameters in order to accommodate the difference in the protocol variants supported, namely ANSI SCCP T1.112 (1992), ANSI SCCP T1.112 (1996), ITU SCCP Q711-716 (03/1993) and ITU SCCP Q711-716 (07/1996):

• Address Information for ITU and ANSI
• Translation Type for ANSI
• Numbering Plan for ANSI
• Encoding Scheme for ANSI
• Nature of Address Indicator for ITU
• Odd Indicator (bit 8 of Address Indicator) for ITU

For GT0001 address information it is expected that for non BCD numbers to be raw data and when BCD encoding, to be 2 BCD numbers per byte (i.e 2 address_signals/digits/numbers per byte when BCD encoding).
The nature of address indicator for GT0001, only uses bits 1 to 7 for its coding, therefore bit 8 of the octet contains the even/odd indicator which is coded as 0 for even or 1 for odd number of address_signals/digits/numbers.

Bit 8	Odd/Even
0	Even number of address signals
1	Odd number of address signals

GTIndicator0001 has a boolean oddIndicator, which can be used to determine the contents of the even/odd Indicator field. The isOddIndicator will return true when there is an odd number of address_signals/digits/numbers and false when there is an even number of address_signals/digits/numbers.

Global title format for Indicator 0001

Version:

1.1

Author:

Sun Microsystems Inc.

See Also:

GlobalTitle, Serialized Form

Constructor Summary

GTIndicator0001(byte translationType, int numberingPlan, int encodingScheme, byte[] addressInformation)
Constructs a new Global Title Indicator-0001 for an ANSI implementation of the JAIN TCAP API with the relevent mandatory parameters.

GTIndicator0001(int natureAddrIndicator, boolean isOddIndicator, byte[] addressInformation)
Constructs a new Global Title Indicator-0001 for an ITU implementation of the JAIN TCAP API with the relevent mandatory parameters.

Method Summary

int	getEncodingScheme() Gets the Encoding Scheme of this Global Title Indicator-0001.
int	getGTIndicator() This method returns the format of this Global Title - GTINDICATOR-0001
int	getNatureOfAddrInd() Gets the Nature of Address Indicator of this Global Title Indicator-0001.
int	getNumberingPlan() Gets the Numbering Plan of this Global Title Indicator-0001.
byte	getTranslationType() Gets the Translation Type of this Global Title Indicator-0001, which directs the message to the appropriate global title translator.
boolean	isOddIndicator() Gets the Odd Indicator, bit 8 of the Nature of Address Indicator.
void	setEncodingScheme(int encodingScheme) Sets the Encoding Scheme of this Global Title Indicator-0001.
void	setNatureOfAddrInd(int natureOfAddrInd) Sets the Nature of Address Indicator of this Global Title Indicator-0001.
void	setNumberingPlan(int numberingPlan) Sets the Numbering Plan of this Global Title Indicator-0001.
void	setOddIndicator(boolean oddIndicator) Sets the Odd Indicator, bit 8 of the Nature of Address Indicator.
void	setTranslationType(byte translationType) Sets the Translation Type of this Global Title Indicator-0001, which directs the message to the appropriate global title translator.
java.lang.String	toString() String representation of class GTIndicator0001

Methods inherited from class jain.protocol.ss7.GlobalTitle

getAddressInformation, setAddressInformation

Methods inherited from class java.lang.Object

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

Constructor Detail

GTIndicator0001

public GTIndicator0001(int natureAddrIndicator,
                       boolean isOddIndicator,
                       byte[] addressInformation)

Constructs a new Global Title Indicator-0001 for an ITU implementation of the JAIN TCAP API with the relevent mandatory parameters.

Parameters:

natureAddrIndicator - the new nature of address supplied to the constructor

isOddIndicator - the new Odd Indicator supplied to the constructor

addressInformation - the new address Information supplied to the constructor

GTIndicator0001

public GTIndicator0001(byte translationType,
                       int numberingPlan,
                       int encodingScheme,
                       byte[] addressInformation)

Constructs a new Global Title Indicator-0001 for an ANSI implementation of the JAIN TCAP API with the relevent mandatory parameters.

Parameters:

translationType - the new translation type supplied to the constructor

numberingPlam - the new numbering Plan supplied to the constructor

encodingScheme - the new encoding scheme supplied to the constructor

addressInformation - the new address Information supplied to the constructor

Method Detail

setTranslationType

public void setTranslationType(byte translationType)

Sets the Translation Type of this Global Title Indicator-0001, which directs the message to the appropriate global title translator. The translation type is only specific to an ANSI implementation of the JAIN TCAP API for GTIndicator-0001.

Parameters:

translationType - The new Translation Type value

setNumberingPlan

public void setNumberingPlan(int numberingPlan)

Sets the Numbering Plan of this Global Title Indicator-0001. The numbering plan is only specific to an ANSI implementation of the JAIN TCAP API for GTIndicator-0001.

Parameters:

numberingPlan - one of the following:-

• NP_UNKOWN - Indicates an unknown Numbering Plan
• NP_ISDN_TEL - Indicates ISDN/Telephony Numbering Plan
• NP_RESERVED - Indicates a reserved Numbering Plan.
• NP_DATA - Indicates Data Numbering Plan
• NP_TELEX - Indicates a Telex Numbering Plan
• NP_MARITIME_MOBILE - Indicates a Maritime Mobile Numbering Plan
• NP_LAND_MOBILE - Indicates a Land Mobile Numbering Plan
• NP_ISDN_MOBILE - Indicates an ISDN Mobile Numbering Plan

See Also:

AddressConstants

setEncodingScheme

public void setEncodingScheme(int encodingScheme)

Sets the Encoding Scheme of this Global Title Indicator-0001. The encoding scheme is only specific to an ANSI implementation of the JAIN TCAP API for GTIndicator-0001.

Parameters:

encodingScheme - one of the following:-

• ES_UNKNOWN - Indicates an unknown encoding scheme.
• ES_ODD - Indicates BCD, odd number of digits
• ES_EVEN - Indicates - BCD, even number of digits
• ES_NATIONAL_SPECIFIC - Indicates a national specific

See Also:

AddressConstants

setNatureOfAddrInd

public void setNatureOfAddrInd(int natureOfAddrInd)

Sets the Nature of Address Indicator of this Global Title Indicator-0001. The Nature of address indicator is only specific to the ITU implementation of the JAIN TCAP API.

Parameters:

natureOfAddrInd - The new Nature Of Address Indicator value

setOddIndicator

public void setOddIndicator(boolean oddIndicator)

Sets the Odd Indicator, bit 8 of the Nature of Address Indicator. The Odd Indicator is only specific to the ITU version of GTIndicator-0001. This field is defaulted to false therefore "Odd BCD Encoding".

Parameters:

oddIndicator - one of the following:-

• true - if Even BCD Encoding.
• false - if Odd BCD Encoding.

getTranslationType

public byte getTranslationType()
                        throws MandatoryParameterNotSetException

Gets the Translation Type of this Global Title Indicator-0001, which directs the message to the appropriate global title translator. The translation type is only specific to an ANSI implementation of the JAIN TCAP API for GTIndicator-0001.

Returns:

The Translation Type value

Throws:

MandatoryParameterNotSetException - thrown when this parameter has not been set.

getNumberingPlan

public int getNumberingPlan()
                     throws MandatoryParameterNotSetException

Gets the Numbering Plan of this Global Title Indicator-0001. The numbering plan is only specific to an ANSI implementation of the JAIN TCAP API for GTIndicator-0001.

Returns:

The Numbering Plan - one of the following:-

• NP_UNKOWN - Indicates an unknown Numbering Plan
• NP_ISDN_TEL - Indicates ISDN/Telephony Numbering Plan
• NP_RESERVED - Indicates a reserved Numbering plan in ANSI.
• NP_DATA - Indicates Data Numbering Plan
• NP_TELEX - Indicates a Telex Numbering Plan
• NP_MARITIME_MOBILE - Indicates a Maritime Mobile Numbering Plan
• NP_LAND_MOBILE - Indicates a Land Mobile Numbering Plan
• NP_ISDN_MOBILE - Indicates an ISDN Mobile Numbering Plan

Throws:

MandatoryParameterNotSetException - thrown when this mandatory parameter has not been set.

See Also:

AddressConstants

getEncodingScheme

public int getEncodingScheme()
                      throws MandatoryParameterNotSetException

Gets the Encoding Scheme of this Global Title Indicator-0001. The encoding scheme is only specific to an ANSI implementation of the JAIN TCAP API for GTIndicator-0001.

Returns:

the Encoding Scheme - one of the following:-

• ES_UNKNOWN - Indicates an unknown encoding scheme.
• ES_ODD - Indicates BCD, odd number of digits
• ES_EVEN - Indicates BCD, even number of digits
• ES_NATIONAL_SPECIFIC - Indicates a national specific

Throws:

MandatoryParameterNotSetException - thrown if this mandatory parameter has not been set.

See Also:

AddressConstants

getNatureOfAddrInd

public int getNatureOfAddrInd()
                       throws MandatoryParameterNotSetException

Gets the Nature of Address Indicator of this Global Title Indicator-0001. The nature of address indicator is only specific to the ITU implementation of the JAIN TCAP API.

Returns:

- one of the following:

• NA_UNKNOWN - Indicates a unknown Nature of Address
• NA_SUBSCRIBER - Indicates a subscriber number
• NA_RESERVED - Reserved for national use Nature of Address Indicator
• NA_NATIONAL_SIGNIFICANT - Indicates a National Significant Number
• NA_INTERNATIONAL - Indicates an international number

Throws:

MandatoryParameterNotSetException - thrown if this mandatory parameter has not been set

See Also:

AddressConstants

isOddIndicator

public boolean isOddIndicator()

Gets the Odd Indicator, bit 8 of the Nature of Address Indicator. The Odd Indicator is only specific to the ITU version of the GTIndicator-0001. This field is defaulted to false therefore "Odd BCD Encoding".

Returns:

one of the following:-

• true - if Even BCD Encoding.
• false - if Odd BCD Encoding.

getGTIndicator

public int getGTIndicator()

This method returns the format of this Global Title - GTINDICATOR-0001

Overrides:

getGTIndicator in class GlobalTitle

Returns:

The Global Title Indicator value

toString

public java.lang.String toString()

String representation of class GTIndicator0001

Overrides:

toString in class GlobalTitle

Returns:

String provides description of class GTIndicator0001