no.kantega.id.no

Class NorwegianIdNumber

java.lang.Object

no.kantega.id.api.IdNumber

no.kantega.id.api.LocalIdNumber

no.kantega.id.no.NorwegianIdNumber

public class NorwegianIdNumber
extends LocalIdNumber

Representation of a fødelsnummer which is issued by the Norwegian Skatteetaten. A fø dselsnummer consists of 11 digits where the first six digits mark the birthday in the DDMMYY format containing the last two digits of the birth year. The following five numbers are also known as the personnummer which differentiates between individuals. The last two digits of the personnummer are control numbers, specified by

1. k1 = 11 - ((3 * d1 + 7 * d2 + 6 * m1 + 1 * m2 + 8 * y1 + 9 * y2 + 4 * p1 + 5 * p2 + 2 * p3) % 11)
2. k2 = 11 - ((5 * d1 + 4 * d2 + 3 * m1 + 2 * m2 + 7 * y1 + 6 * y2 + 5 * p1 + 4 * p2 + 3 * p3 + 2 * k1) % 11)

with kn representing the n-th control number and d, m, y, p equally presenting the day, month or year of birth as given by the fødselsnummer and p meaning a digit of the personnummer.

The third digit of the personnummer gives information about the gender of a person with even digits for female and odd digits for male persons. The exact birth year can be deducted from the known last two digits together with the personnummer where the first three digits of the personnummer determines:

1. 000 - 499: A person is born in the 1900.
2. 500 - 749: A person is born between 1854 - 1899.
3. 500 - 999: A person is born between 2000 - 2039.
4. 900 - 999: A person is born between 1940 - 1999.

Note that a Norwegian ID number's validity is dependant of the type as defined by NorwegianIdNumber.Type.

See Also:

NorwegianIdNumber.Type, IdNumber

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NorwegianIdNumber.Type Describes the type of the given Norwegian ID.

Field Summary

Fields inherited from class no.kantega.id.api.IdNumber

idToken

Constructor Summary

Constructors

Constructor and Description
NorwegianIdNumber(String idToken) Creates a new Norwegian id number representation with Norwegian locale.
NorwegianIdNumber(String idToken, Locale locale) Creates a new Norwegian id number representation with the given locale.

Method Summary

Modifier and Type	Method and Description
Optional<LocalDate>	birthday() Extracts the birthday of this ID.
static Optional<LocalDate>	birthday(IdNumber idNumber) Extracts the birthday of the given ID.
static NorwegianIdNumber	forId(String idToken) Convenience constructor method for creating a Norwegian ID with Norwegian locale.
static NorwegianIdNumber	forId(String idToken, Locale locale) Convenience constructor method for creating a Norwegian ID with the given locale.
Optional<Gender>	gender() Extracts the gender of this ID.
static Optional<Gender>	gender(IdNumber idNumber) Extracts the gender of the given ID.
boolean	isValid() Checks the validity of this ID.
protected boolean	supports(Locale locale) Defines support method for given locale.
Optional<NorwegianIdNumber.Type>	type() Extracts the type of this ID.
static Optional<NorwegianIdNumber.Type>	type(IdNumber idNumber) Extracts the type of the given ID.
static boolean	valid(IdNumber idNumber) Checks the validity of a given ID.

Methods inherited from class no.kantega.id.api.IdNumber

age, birthday, gender, getIdToken, isValid

Methods inherited from class java.lang.Object

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

Constructor Detail

NorwegianIdNumber

public NorwegianIdNumber(String idToken)

Creates a new Norwegian id number representation with Norwegian locale.

Parameters:

idToken - The id token for this id.

NorwegianIdNumber

public NorwegianIdNumber(String idToken,
                         Locale locale)

Creates a new Norwegian id number representation with the given locale.

Parameters:

idToken - The id token for this id.

locale - The locale of the ID.

Method Detail

forId

public static NorwegianIdNumber forId(String idToken)

Convenience constructor method for creating a Norwegian ID with Norwegian locale.

Parameters:

idToken - The token for this id.

Returns:

A new Norwegian ID token.

forId

public static NorwegianIdNumber forId(String idToken,
                                      Locale locale)

Convenience constructor method for creating a Norwegian ID with the given locale.

Parameters:

idToken - The token for this id.

locale - The locale of the ID.

Returns:

A new Norwegian ID token.

gender

public static Optional<Gender> gender(IdNumber idNumber)

Extracts the gender of the given ID.

Parameters:

idNumber - The ID to be examined.

Returns:

The gender of this ID by the Norwegian ID definition, if retrievable.

gender

public Optional<Gender> gender()

Extracts the gender of this ID.

Returns:

The gender of this ID, if known.

valid

public static boolean valid(IdNumber idNumber)

Checks the validity of a given ID.

Parameters:

idNumber - The ID to be examined.

Returns:

true if the given ID is valid by measures of the Norwegian ID definition.

isValid

public boolean isValid()

Checks the validity of this ID.

Returns:

true if this ID is valid by measures of the Norwegian ID definition.

birthday

public static Optional<LocalDate> birthday(IdNumber idNumber)

Extracts the birthday of the given ID.

Parameters:

idNumber - The ID to be examined.

Returns:

The birthday of the person this ID is assigned to by the Norwegian ID definition, if retrievable.

birthday

public Optional<LocalDate> birthday()

Extracts the birthday of this ID.

Returns:

The birthday of the person this ID is assigned to by the Norwegian ID definition, if retrievable.

type

public static Optional<NorwegianIdNumber.Type> type(IdNumber idNumber)

Extracts the type of the given ID.

Parameters:

idNumber - The ID to be examined.

Returns:

The type of the ID by the Norwegian ID definition, if retrievable.

type

public Optional<NorwegianIdNumber.Type> type()

Extracts the type of this ID.

Returns:

The type of this ID by the Norwegian ID definition, if retrievable.

supports

protected boolean supports(Locale locale)

Description copied from class: LocalIdNumber

Defines support method for given locale. Users of this class are supposed to override this method.

Overrides:

supports in class LocalIdNumber

Parameters:

locale - given locale.

Returns:

true if locale is supported, false otherwise.