com.ihr.xbrl.om.resolvers

Class TaxonomyPackageURIResolver.TaxonomyPackage

java.lang.Object

com.ihr.xbrl.om.resolvers.TaxonomyPackageURIResolver.TaxonomyPackage

Enclosing class:

TaxonomyPackageURIResolver

public static class TaxonomyPackageURIResolver.TaxonomyPackage
extends java.lang.Object

Represents a package (zip file) that contains a set of entry points and mapping rules as indicated in the Taxonomy Packages Specification(s) .

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
TaxonomyPackage(java.lang.String startPath, java.io.File zipfileFile, java.lang.String version, java.util.Map<java.lang.String,TaxonomyPackageURIResolver.PackageByLangInfo> infoByLang, java.util.Map<java.net.URI,java.lang.String> remappings, java.util.Vector<TaxonomyPackageURIResolver.EntryPointHRefs> allEpHRefs) Instantiates a new taxonomy package.

Method Summary

Modifier and Type	Method and Description
boolean	deleteFile() Delete file.
boolean	equals(java.lang.Object obj) Equals.
java.util.Vector<TaxonomyPackageURIResolver.EntryPointHRefs>	getAllEpHRefs() Gets the all ep H refs.
java.util.Iterator<java.net.URI>	getBases() Gets the bases.
java.util.Collection<TaxonomyPackageURIResolver.EntryPointLangInfo>	getEntryPoints() Gets the entry points.
java.lang.String	getIdentifier() Gets the identifier.
java.util.Iterator<java.net.URI>	getIterator() Prepares an iterator over all files represented as the official URL in order to allow the checker to verify the file existence and compare content.
java.lang.String	getLicenseHREF() Gets the license HREF.
java.lang.String	getLicenseName() Gets the license name.
java.lang.String	getName() Gets the name.
java.lang.String	getNamespace() Gets the namespace.
java.lang.String	getPublicationDate() Gets the publication date.
java.util.HashMap<java.lang.String,java.lang.String>	getPublisherByLang() Gets the publisher by lang.
java.lang.String	getPublisherCountry() Gets the publisher country.
java.lang.String	getPublisherURL() Gets the publisher URL.
java.util.Collection<java.net.URI>	getRemappings() Gets the remappings.
java.lang.String	getReplaceWith(java.net.URI prefix) Gets the replace with.
java.lang.String	getStartPath() Access to the taxonomy package start path.
java.lang.String	getSupersededTP() Gets the superseded TP.
java.lang.String	getVersion() Gets the version.
java.lang.String	getVersioningReports() Gets the versioning reports.
java.lang.String	getZipFile() Gets the zip file.
int	hashCode() Hash code.
boolean	isCheckMultipleRoot() Checks if is check multiple root.
javax.xml.transform.Source	resolve(java.lang.String absoluteOfficialURI) Resolve.
javax.xml.transform.Source	resolve(java.net.URI key, java.lang.String absoluteOfficialURI) Resolve.
void	setCheckMultipleRoot(boolean b) Sets the check multiple root.
void	setIdentifier(java.lang.String identifier) Sets the identifier.
void	setLicenseHREF(java.lang.String licenseHREF) Sets the license HREF.
void	setLicenseName(java.lang.String licenseName) Sets the license name.
void	setNamespace(java.lang.String namespace) Sets the namespace.
void	setOasisCatalog(java.lang.String oasisCatalogFile) At this time it is required to load all rewriteURI entries in the incoming catalog file and populate the remapingsByUri.
void	setPublicationDate(java.lang.String publicationDate) Sets the publication date.
void	setPublisherByLang(java.util.HashMap<java.lang.String,java.lang.String> publisherByLang) Sets the publisher by lang.
void	setPublisherCountry(java.lang.String publisherCountry) Sets the publisher country.
void	setPublisherURL(java.lang.String publisherURL) Sets the publisher URL.
void	setSupersededTP(java.lang.String supersededTP) Sets the superseded TP.
void	setVersioningReports(java.lang.String versioningReports) Sets the versioning reports.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaxonomyPackage

public TaxonomyPackage(java.lang.String startPath,
                       java.io.File zipfileFile,
                       java.lang.String version,
                       java.util.Map<java.lang.String,TaxonomyPackageURIResolver.PackageByLangInfo> infoByLang,
                       java.util.Map<java.net.URI,java.lang.String> remappings,
                       java.util.Vector<TaxonomyPackageURIResolver.EntryPointHRefs> allEpHRefs)

Instantiates a new taxonomy package.

Parameters:

startPath - the start path

zipfileFile - the zipfile file

version - the version

infoByLang - the info by lang

remappings - the remappings

allEpHRefs - the all ep H refs

Method Detail

getBases

public java.util.Iterator<java.net.URI> getBases()

Gets the bases.

Returns:

the bases

getRemappings

public java.util.Collection<java.net.URI> getRemappings()

Gets the remappings.

Returns:

the remappings

getReplaceWith

public java.lang.String getReplaceWith(java.net.URI prefix)

Gets the replace with.

Parameters:

prefix - the prefix

Returns:

the replace with

getZipFile

public java.lang.String getZipFile()

Gets the zip file.

Returns:

the zip file

getStartPath

public java.lang.String getStartPath()

Access to the taxonomy package start path. MUST be equal to the zip file name without the .zip file extension

Returns:

the start path

resolve

public javax.xml.transform.Source resolve(java.lang.String absoluteOfficialURI)

Resolve.

Parameters:

absoluteOfficialURI - the absolute official URI

Returns:

the source

resolve

public javax.xml.transform.Source resolve(java.net.URI key,
                                          java.lang.String absoluteOfficialURI)

Resolve.

Parameters:

key - the key

absoluteOfficialURI - the absolute official URI

Returns:

the source

getVersion

public java.lang.String getVersion()

Gets the version.

Returns:

the version

getName

public java.lang.String getName()

Gets the name.

Returns:

the name

getAllEpHRefs

public java.util.Vector<TaxonomyPackageURIResolver.EntryPointHRefs> getAllEpHRefs()

Gets the all ep H refs.

Returns:

the allEpHRefs

getEntryPoints

public java.util.Collection<TaxonomyPackageURIResolver.EntryPointLangInfo> getEntryPoints()

Gets the entry points.

Returns:

the entry points

deleteFile

public boolean deleteFile()

Delete file.

Returns:

true, if successful

hashCode

public int hashCode()

Hash code.

Overrides:

hashCode in class java.lang.Object

Returns:

the int

equals

public boolean equals(java.lang.Object obj)

Equals.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the obj

Returns:

true, if successful

setOasisCatalog

public void setOasisCatalog(java.lang.String oasisCatalogFile)
                     throws TPValidationException

At this time it is required to load all rewriteURI entries in the incoming catalog file and populate the remapingsByUri.

Parameters:

oasisCatalogFile - the new oasis catalog

Throws:

TPValidationException - the TP validation exception

setIdentifier

public void setIdentifier(java.lang.String identifier)

Sets the identifier.

Parameters:

identifier - the new identifier

getIdentifier

public java.lang.String getIdentifier()

Gets the identifier.

Returns:

the identifier indicated in the identifier element in the taxonomyPackage.xml file might be null if there are no identifier present, note this element did not exist on specifications prior to the REC status

setLicenseName

public void setLicenseName(java.lang.String licenseName)

Sets the license name.

Parameters:

licenseName - the new license name

getLicenseName

public java.lang.String getLicenseName()

Gets the license name.

Returns:

the licenseName

setLicenseHREF

public void setLicenseHREF(java.lang.String licenseHREF)

Sets the license HREF.

Parameters:

licenseHREF - the new license HREF

getLicenseHREF

public java.lang.String getLicenseHREF()

Gets the license HREF.

Returns:

the licenseHREF

setPublisherByLang

public void setPublisherByLang(java.util.HashMap<java.lang.String,java.lang.String> publisherByLang)

Sets the publisher by lang.

Parameters:

publisherByLang - the publisher by lang

getPublisherByLang

public java.util.HashMap<java.lang.String,java.lang.String> getPublisherByLang()

Gets the publisher by lang.

Returns:

the publisherByLang

setPublisherURL

public void setPublisherURL(java.lang.String publisherURL)

Sets the publisher URL.

Parameters:

publisherURL - the new publisher URL

getPublisherURL

public java.lang.String getPublisherURL()

Gets the publisher URL.

Returns:

the publisherURL

setPublisherCountry

public void setPublisherCountry(java.lang.String publisherCountry)

Sets the publisher country.

Parameters:

publisherCountry - the new publisher country

getPublisherCountry

public java.lang.String getPublisherCountry()

Gets the publisher country.

Returns:

the publisherCountry

setPublicationDate

public void setPublicationDate(java.lang.String publicationDate)

Sets the publication date.

Parameters:

publicationDate - the new publication date

getPublicationDate

public java.lang.String getPublicationDate()

Gets the publication date.

Returns:

the publicationDate

setSupersededTP

public void setSupersededTP(java.lang.String supersededTP)

Sets the superseded TP.

Parameters:

supersededTP - the new superseded TP

getSupersededTP

public java.lang.String getSupersededTP()

Gets the superseded TP.

Returns:

the supersededTP

setVersioningReports

public void setVersioningReports(java.lang.String versioningReports)

Sets the versioning reports.

Parameters:

versioningReports - the new versioning reports

setNamespace

public void setNamespace(java.lang.String namespace)

Sets the namespace.

Parameters:

namespace - the namespace to set. The namespace is used to determine the specification version

getNamespace

public java.lang.String getNamespace()

Gets the namespace.

Returns:

the namespace

getVersioningReports

public java.lang.String getVersioningReports()

Gets the versioning reports.

Returns:

the versioningReports

setCheckMultipleRoot

public void setCheckMultipleRoot(boolean b)

Sets the check multiple root.

Parameters:

b - the new check multiple root

isCheckMultipleRoot

public boolean isCheckMultipleRoot()

Checks if is check multiple root.

Returns:

the bCheckMultipleRoot

getIterator

public java.util.Iterator<java.net.URI> getIterator()

Prepares an iterator over all files represented as the official URL in order to allow the checker to verify the file existence and compare content.

Returns:

the iterator