Package uk.num.numlib.util

Class BaseLookupGenerator

java.lang.Object

uk.num.numlib.util.BaseLookupGenerator

All Implemented Interfaces:

LookupGenerator

Direct Known Subclasses:

DomainLookupGenerator, EmailLookupGenerator, URLLookupGenerator

public abstract class BaseLookupGenerator
extends java.lang.Object
implements LookupGenerator

Nested Class Summary

Nested classes/interfaces inherited from interface uk.num.numlib.util.LookupGenerator

LookupGenerator.NumUriComponents, LookupGenerator.TrailingDot

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	branch
protected java.lang.String	domain
static java.lang.String	HTTP_PROTOCOL
static java.lang.String	HTTPS_PROTOCOL
static java.lang.String	NUM_PROTOCOL
protected java.lang.String	numId

Constructor Summary

Constructors

Constructor	Description
BaseLookupGenerator(@NonNull java.lang.String numId)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getHostedLocation(int moduleNumber)
java.lang.String	getIndependentLocation(int moduleNumber)
java.lang.String	getPopulatorLocation(int moduleNumber)
java.lang.String	getRootHostedLocation(int moduleNumber)
java.lang.String	getRootHostedLocationNoModuleNumber(LookupGenerator.TrailingDot addTrailingDot)	Note - this method does not return a trailing dot
java.lang.String	getRootIndependentLocation(int moduleNumber)
java.lang.String	getRootIndependentLocationNoModuleNumber(LookupGenerator.TrailingDot addTrailingDot)	Note - this method does not return a trailing dot
boolean	isDomainRoot()
protected static java.lang.String	normaliseDomainName(@NonNull java.lang.String numId)	Convert a domain name or URL into a normalised name by removing 'www.' and any trailing '.'.
protected static java.lang.String	normalisePath(java.lang.String path)	Accept the 'path' part of a URL and convert it to a format for use in NUM Protocol Queries.
static LookupGenerator.NumUriComponents	parseNumUriString(@NonNull java.lang.String possibleNumUri)	Attempt to parse a NUM URI String into its components.
protected java.lang.String	transformBranch(java.lang.String s)	Convert "foo/bar" into "bar.foo"

Methods inherited from class java.lang.Object

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

Field Detail

NUM_PROTOCOL

public static final java.lang.String NUM_PROTOCOL

See Also:

Constant Field Values

HTTPS_PROTOCOL

public static final java.lang.String HTTPS_PROTOCOL

See Also:

Constant Field Values

HTTP_PROTOCOL

public static final java.lang.String HTTP_PROTOCOL

See Also:

Constant Field Values

numId

protected final java.lang.String numId

branch

protected java.lang.String branch

domain

protected java.lang.String domain

Constructor Detail

BaseLookupGenerator

public BaseLookupGenerator(@NonNull
                           @NonNull java.lang.String numId)

Method Detail

normaliseDomainName

protected static java.lang.String normaliseDomainName(@NonNull
                                                      @NonNull java.lang.String numId)

Convert a domain name or URL into a normalised name by removing 'www.' and any trailing '.'.

Parameters:

numId - java.lang.String The Not Null domain name string or URL.

Returns:

A normalised java.lang.String domain name.

normalisePath

protected static java.lang.String normalisePath(java.lang.String path)

Accept the 'path' part of a URL and convert it to a format for use in NUM Protocol Queries. I.e. split by '/' and '.', reverse the results and join with '.', prefix with an underscore and replace all spaces by underscores.

Parameters:

path - java.lang.String the path part of the URL - i.e. the result of URL.getPath()

Returns:

java.lang.String the normalised path.

parseNumUriString

public static LookupGenerator.NumUriComponents parseNumUriString(@NonNull
                                                                 @NonNull java.lang.String possibleNumUri)

Attempt to parse a NUM URI String into its components.

Parameters:

possibleNumUri - a String

Returns:

NumUriComponents

getIndependentLocation

public java.lang.String getIndependentLocation(int moduleNumber)
                                        throws NumInvalidParameterException

Specified by:

getIndependentLocation in interface LookupGenerator

Throws:

NumInvalidParameterException

getHostedLocation

public java.lang.String getHostedLocation(int moduleNumber)
                                   throws NumInvalidParameterException

Specified by:

getHostedLocation in interface LookupGenerator

Throws:

NumInvalidParameterException

isDomainRoot

public boolean isDomainRoot()

Specified by:

isDomainRoot in interface LookupGenerator

transformBranch

protected java.lang.String transformBranch(java.lang.String s)

Convert "foo/bar" into "bar.foo"

Parameters:

s - the branch part of a location specifier

Returns:

the transformed branch part

getPopulatorLocation

public java.lang.String getPopulatorLocation(int moduleNumber)
                                      throws NumInvalidParameterException

Specified by:

getPopulatorLocation in interface LookupGenerator

Throws:

NumInvalidParameterException

getRootIndependentLocation

public java.lang.String getRootIndependentLocation(int moduleNumber)
                                            throws NumInvalidParameterException

Specified by:

getRootIndependentLocation in interface LookupGenerator

Throws:

NumInvalidParameterException

getRootHostedLocation

public java.lang.String getRootHostedLocation(int moduleNumber)
                                       throws NumInvalidParameterException

Specified by:

getRootHostedLocation in interface LookupGenerator

Throws:

NumInvalidParameterException

getRootIndependentLocationNoModuleNumber

public java.lang.String getRootIndependentLocationNoModuleNumber(LookupGenerator.TrailingDot addTrailingDot)

Note - this method does not return a trailing dot

Specified by:

getRootIndependentLocationNoModuleNumber in interface LookupGenerator

Returns:

String

getRootHostedLocationNoModuleNumber

public java.lang.String getRootHostedLocationNoModuleNumber(LookupGenerator.TrailingDot addTrailingDot)

Note - this method does not return a trailing dot

Specified by:

getRootHostedLocationNoModuleNumber in interface LookupGenerator

Returns:

String