com.ihr.xbrl.util

Class URITools

java.lang.Object

com.ihr.xbrl.util.URITools

public class URITools
extends java.lang.Object

The Class URITools.

Method Summary

Modifier and Type	Method and Description
static java.net.URI	addPath(java.net.URI uri, java.lang.String... parts) Concatenates all parts using the / separator at the end of URI indicated by rm parameter.
static boolean	areSameUri(java.net.URI uri1, java.net.URI uri2) Are same uri.
static void	checkSecureScheme(javax.xml.transform.sax.SAXSource source) This method will check the content of source to find if the file indicated is a https scheme URL rather than http URL.
static java.net.URI	commonBase(java.util.List<java.net.URI> uris) Computes the common part of incoming URIS and returns a new URI for that part.
static boolean	compareAuthorityAndPath(java.net.URI uri1, java.net.URI uri2) Compare authority and paths of two URIs and returns true if they are equals.
static java.lang.String	decodeUri(java.lang.String uri) Decodes a string according to RFC 2396.
static void	decodeUri(java.lang.String uri, java.lang.StringBuilder buf) Decodes a string according to RFC 2396.
static java.lang.String	decodeUriInUTF8(java.lang.String uri) Decode URI string and convert UTF8 encoded characters to Java string characters.
static java.lang.String	encodeUri(java.lang.String uri) Encodes a string according to RFC 2396.
static void	encodeUri(java.lang.String uri, java.lang.StringBuilder buf) Encodes a string according to RFC 2396.
static java.lang.String	fileName(java.lang.String path) If the path passed contains directories this returns just the last part of the path.
static java.net.URI	fixEndWithSlash(java.lang.String uri) Creates an URI that ends with a slash character '/' if the input string in the uri parameter does not ends with the slash character.
static java.lang.String	fixEndWithSlashString(java.lang.String uri) Creates an URI that ends with a slash character '/' if the input string in the uri parameter does not ends with the slash character.
static java.lang.String	fixFileSchemeURIToString(java.net.URI uri) If the URI passed in as a parameter is of the file: scheme, then toString does not return file:/// but file:/ This seems to be incorrect so this method just fix this.
static java.lang.String	getAuthorityAndPath(java.net.URI uri) Returns a string that contains only the uri authority and path.
static java.net.URI	getDetectIsURIOrFile(java.lang.String fileString) Detects if the input string is a file uri, a remote uri or a local file name and returns a uri pointing to the target.
static java.lang.String	getFileName(java.net.URI fUri) Returns only the file name from path in the fUri parameter or the empty string if the fURI ends with slash.
static java.lang.String	getNID(java.net.URI urn) For URN URIs this method returns the NID.
static java.net.URI	getNormalURI(java.net.URI sinonimURI) Gets the normal uri.
static java.net.URL	getURLAfterRedirects(java.net.URL testURL) Gets the URL after redirects.
static java.net.URL	getURLAfterRedirects(java.net.URL testURL, java.lang.String method) Gets the URL after redirects.
static boolean	hasCommonBase(java.util.List<java.net.URI> uris) Checks the list of uris received has all the scheme and host in common so a call to #commonBase(ArrayList) will not raise an exception.
static java.lang.String	hashResources() Hash resources.
static java.net.URI	makeAbsolute(java.net.URI base, java.net.URI uri) Make absolute.
static java.net.URI	makeProperFileName(java.net.URI baseURI, DTSContainer dts, java.lang.String extension) Generates an absolute file name in the same directory indicated by baseURI using the role type to extract information from it and adding the extension indicated in the extension parameter.
static java.net.URI	makeProperFileName(java.net.URI baseURI, XBRLRoleType role, java.lang.String extension) Generates an absolute file name in the same directory indicated by baseURI using the role type to extract information from it and adding the extension indicated in the extension parameter.
static java.lang.String	packURI(java.lang.String uri, int maxLength) Takes a string representation of an URI and packs it to a maximum length of maxLenght characters.
static java.net.URI	relativize(java.net.URI base, java.net.URI full) Creates a new URI that contains a path relative to the base URI.
static java.net.URI	relativizeMore(java.net.URI from, java.net.URI to) Computes a relative path from the URI in the from argument to the URI in the to argument This function does not work if the incoming parameters contain several slashes together ie (file:/C:/hello////this%20is%20a%20test).
static java.net.URI	removeExtension(java.net.URI uri) Removes the extension from the file name.
static java.net.URI	removeFragment(java.net.URI uri) Removes the fragment.
static java.lang.String	removeTrailingSlash(java.lang.String pathName) Removes forward slash characters and the end of this pathName.
static java.lang.String	resolveXBRLScheme(java.lang.String uriIsASCII) If the protocol of this URI is xbrl. change it to be http or file
static boolean	safeCheckIsFilePath(java.lang.String uri) Safe check is file path.
static boolean	safeCheckIsFileUri(java.lang.String uri) Returns true if the string is a valid URI.
static boolean	safeCheckIsHttpUri(java.lang.String uri) Safe check is http uri.
static boolean	safeCheckIsUriValid(java.lang.String uri) Safe check is uri valid.
static java.lang.String	URItoFileString(java.lang.String path) If the path passed in is a URI using the file scheme, this method will return back a file name using OS conventions.
static java.net.URI	URLtoFileName(java.net.URL u) This function transforms a URL of the form file:/C:/Program Files/svs/xbrljlib-2.0.jar into a proper file URI to be used as a parameter for the File(URI) method.

Methods inherited from class java.lang.Object

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

Method Detail

getNormalURI

public static java.net.URI getNormalURI(java.net.URI sinonimURI)

Gets the normal uri. This is a URI without fragment, user info and port. if it is a file uri, a File is created from the uri and then the URI of the canonical file is returned

This method is provided to create a unique key to identify the URI. The converted URI might not be used to connect to any host because important information is removed such as the user info and port number

Parameters:

sinonimURI - the sinonim uri

Returns:

the normal uri

areSameUri

public static boolean areSameUri(java.net.URI uri1,
                                 java.net.URI uri2)

Are same uri.

Parameters:

uri1 - the uri1

uri2 - the uri2

Returns:

true, if successful

makeAbsolute

public static java.net.URI makeAbsolute(java.net.URI base,
                                        java.net.URI uri)

Make absolute.

Parameters:

base - the base

uri - the uri

Returns:

the uri

relativize

public static java.net.URI relativize(java.net.URI base,
                                      java.net.URI full)

Creates a new URI that contains a path relative to the base URI. This function does not adds .. to go from the base path to the full path

Parameters:

base - URI

full - URI

Returns:

URI

relativizeMore

public static java.net.URI relativizeMore(java.net.URI from,
                                          java.net.URI to)

Computes a relative path from the URI in the from argument to the URI in the to argument This function does not work if the incoming parameters contain several slashes together ie (file:/C:/hello////this%20is%20a%20test).

Parameters:

from - URI Absolute URI

to - URI Absolute URI

Returns:

URI

removeFragment

public static java.net.URI removeFragment(java.net.URI uri)

Removes the fragment.

Parameters:

uri - the uri

Returns:

the uri

encodeUri

public static java.lang.String encodeUri(java.lang.String uri)

Encodes a string according to RFC 2396. According to this spec, any characters outside the range 0x20 - 0x7E must be escaped because they are not printable characters, except for characters in the fragment identifier. Even within this range a number of characters must be escaped. This method will perform this escaping.

Parameters:

uri - The URI to encode.

Returns:

The encoded URI.

encodeUri

public static void encodeUri(java.lang.String uri,
                             java.lang.StringBuilder buf)

Encodes a string according to RFC 2396.

Parameters:

uri - The URI to encode.

buf - The StringBuffer that the encoded URI will be appended to.

See Also:

encodeUri(java.lang.String)

decodeUri

public static java.lang.String decodeUri(java.lang.String uri)

Decodes a string according to RFC 2396. According to this spec, any characters outside the range 0x20 - 0x7E must be escaped because they are not printable characters, except for any characters in the fragment identifier. This method will translate any escaped characters back to the original.

Parameters:

uri - The URI to decode.

Returns:

The decoded URI.

decodeUri

public static void decodeUri(java.lang.String uri,
                             java.lang.StringBuilder buf)

Decodes a string according to RFC 2396.

Parameters:

uri - The URI to decode.

buf - The StringBuffer that the decoded URI will be appended to.

See Also:

decodeUri(java.lang.String)

decodeUriInUTF8

public static java.lang.String decodeUriInUTF8(java.lang.String uri)

Decode URI string and convert UTF8 encoded characters to Java string characters.

Parameters:

uri - the uri

Returns:

the string

packURI

public static java.lang.String packURI(java.lang.String uri,
                                       int maxLength)

Takes a string representation of an URI and packs it to a maximum length of maxLenght characters.

Parameters:

uri - the uri

maxLength - the max length

Returns:

String

Since:

2.6.8

safeCheckIsFilePath

public static boolean safeCheckIsFilePath(java.lang.String uri)

Safe check is file path.

Parameters:

uri - the uri

Returns:

true, if successful

safeCheckIsFileUri

public static boolean safeCheckIsFileUri(java.lang.String uri)

Returns true if the string is a valid URI.

Parameters:

uri - the uri

Returns:

true, if successful

safeCheckIsHttpUri

public static boolean safeCheckIsHttpUri(java.lang.String uri)

Safe check is http uri.

Parameters:

uri - the uri

Returns:

true, if successful

safeCheckIsUriValid

public static boolean safeCheckIsUriValid(java.lang.String uri)

Safe check is uri valid.

Parameters:

uri - the uri

Returns:

true, if successful

URLtoFileName

public static java.net.URI URLtoFileName(java.net.URL u)

This function transforms a URL of the form file:/C:/Program Files/svs/xbrljlib-2.0.jar into a proper file URI to be used as a parameter for the File(URI) method. http://blogs.msdn.com/ie/archive/2006/12/06/file-uris-in-windows.aspx

Parameters:

u - the u

Returns:

the uri

resolveXBRLScheme

public static java.lang.String resolveXBRLScheme(java.lang.String uriIsASCII)

If the protocol of this URI is xbrl. change it to be http or file

Parameters:

uriIsASCII - the uri is ascii

Returns:

the string

fixFileSchemeURIToString

public static java.lang.String fixFileSchemeURIToString(java.net.URI uri)

If the URI passed in as a parameter is of the file: scheme, then toString does not return file:/// but file:/ This seems to be incorrect so this method just fix this. If the URI is of any other type, this method just returns the passedIn URI converted to String using URI.toString()

Parameters:

uri - the uri

Returns:

the string

getDetectIsURIOrFile

public static java.net.URI getDetectIsURIOrFile(java.lang.String fileString)
                                         throws java.net.URISyntaxException

Detects if the input string is a file uri, a remote uri or a local file name and returns a uri pointing to the target.

if the string starts with file: this is a local file uri. if the string starts with http: this is a remote file uri. if the string contains no scheme, then threat it as a local file in the local directory.

Parameters:

fileString - the file string

Returns:

the detect is uri or file

Throws:

java.net.URISyntaxException - the URI syntax exception

fixEndWithSlash

public static java.net.URI fixEndWithSlash(java.lang.String uri)
                                    throws java.net.URISyntaxException

Creates an URI that ends with a slash character '/' if the input string in the uri parameter does not ends with the slash character.

Parameters:

uri - the input string to create a uri from

Returns:

new URI just created from the string or the string after adding a trailing slash character

Throws:

java.net.URISyntaxException - in case the URI raises this exception when it is created

fixEndWithSlashString

public static java.lang.String fixEndWithSlashString(java.lang.String uri)

Creates an URI that ends with a slash character '/' if the input string in the uri parameter does not ends with the slash character. This method does not transforms uri string to URI

Parameters:

uri - the input string to create a uri from

Returns:

new URI (string) just created from the string or the string after adding a trailing slash character

removeTrailingSlash

public static java.lang.String removeTrailingSlash(java.lang.String pathName)

Removes forward slash characters and the end of this pathName.

Parameters:

pathName - the path name

Returns:

the string

URItoFileString

public static java.lang.String URItoFileString(java.lang.String path)

If the path passed in is a URI using the file scheme, this method will return back a file name using OS conventions. In any other cases or errors during the conversion, this method returns the same path

Parameters:

path - the path

Returns:

path or adjusted path

fileName

public static java.lang.String fileName(java.lang.String path)

If the path passed contains directories this returns just the last part of the path.

Parameters:

path - the path

Returns:

the file name

makeProperFileName

public static java.net.URI makeProperFileName(java.net.URI baseURI,
                                              XBRLRoleType role,
                                              java.lang.String extension)

Generates an absolute file name in the same directory indicated by baseURI using the role type to extract information from it and adding the extension indicated in the extension parameter. The generated URI is absolute

Parameters:

baseURI - the base URI to resolve the file name generated.

role - the role type to process and obtain information from in order to prepare a file name

extension - the new file extension

Returns:

an absolute URI in baseURI with a generated file name from role type

makeProperFileName

public static java.net.URI makeProperFileName(java.net.URI baseURI,
                                              DTSContainer dts,
                                              java.lang.String extension)

Generates an absolute file name in the same directory indicated by baseURI using the role type to extract information from it and adding the extension indicated in the extension parameter. The generated URI is absolute

Parameters:

baseURI - the base URI to resolve the file name generated.

dts - the DTSContainer to obtain a name from

extension - the new file extension

Returns:

an absolute URI in baseURI with a generated file name from role type

hashResources

public static java.lang.String hashResources()

Hash resources.

Returns:

the string

commonBase

public static java.net.URI commonBase(java.util.List<java.net.URI> uris)

Computes the common part of incoming URIS and returns a new URI for that part.

if the uris parameter is null this method returns null. If the uris parameter is the empty array, the empty URI is returned This method can raise URISyntaxException if the provided URIs has nothin in common or has only the scheme in common. Use #hasCommonBase(ArrayList) to check for this condition prior to call this method and avoid exceptions.

Parameters:

uris - list of URIs to compute the common part

Returns:

single URI

hasCommonBase

public static boolean hasCommonBase(java.util.List<java.net.URI> uris)

Checks the list of uris received has all the scheme and host in common so a call to #commonBase(ArrayList) will not raise an exception.

Parameters:

uris - list of URIs to compute the common part

Returns:

true if successful

getNID

public static java.lang.String getNID(java.net.URI urn)

For URN URIs this method returns the NID. For example if the URI is urn:xbrl:test:2017-12-31 this method returns xbrl

Parameters:

urn - the urn

Returns:

the NID part of a URN (URI using the urn scheme)

checkSecureScheme

public static void checkSecureScheme(javax.xml.transform.sax.SAXSource source)

This method will check the content of source to find if the file indicated is a https scheme URL rather than http URL. In that case, the systemID on the source is changed accordingly.

Parameters:

source - SAXSource

getURLAfterRedirects

public static java.net.URL getURLAfterRedirects(java.net.URL testURL)
                                         throws java.io.IOException

Gets the URL after redirects.

Parameters:

testURL - the test URL

Returns:

the URL after redirects

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

getURLAfterRedirects

public static java.net.URL getURLAfterRedirects(java.net.URL testURL,
                                                java.lang.String method)
                                         throws java.io.IOException

Gets the URL after redirects.

Parameters:

testURL - the test URL

method - the method

Returns:

the URL after redirects

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

addPath

public static java.net.URI addPath(java.net.URI uri,
                                   java.lang.String... parts)

Concatenates all parts using the / separator at the end of URI indicated by rm parameter.

Parameters:

uri - the uri

parts - String parts to be added

Returns:

valid URI

removeExtension

public static java.net.URI removeExtension(java.net.URI uri)

Removes the extension from the file name.

Parameters:

uri - the uri

Returns:

new URI where the file name has no extension

getFileName

public static java.lang.String getFileName(java.net.URI fUri)

Returns only the file name from path in the fUri parameter or the empty string if the fURI ends with slash.

Parameters:

fUri - the f uri

Returns:

the file name

getAuthorityAndPath

public static java.lang.String getAuthorityAndPath(java.net.URI uri)

Returns a string that contains only the uri authority and path. So it gets rid of the protocol, port and authentication mechanisms

Parameters:

uri - the uri

Returns:

the authority and path

compareAuthorityAndPath

public static boolean compareAuthorityAndPath(java.net.URI uri1,
                                              java.net.URI uri2)

Compare authority and paths of two URIs and returns true if they are equals. https://www.xbrl.org/2020/abc.xsd must be equal to http://www.xbrl.org/2020/abc.xsd

Parameters:

uri1 - the uri 1

uri2 - the uri 2

Returns:

boolean value