com.ihr.xbrl.om.resolvers

Class RSRemoteCatalogResolver.StaticCatalogEntry

java.lang.Object

com.ihr.xbrl.om.resolvers.RSRemoteCatalogResolver.StaticCatalogEntry

All Implemented Interfaces:

java.lang.Comparable<RSRemoteCatalogResolver.StaticCatalogEntry>

Enclosing class:

RSRemoteCatalogResolver

public static class RSRemoteCatalogResolver.StaticCatalogEntry
extends java.lang.Object
implements java.lang.Comparable<RSRemoteCatalogResolver.StaticCatalogEntry>

This is the object model representation of an entry in the static catalog.

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
StaticCatalogEntry(java.lang.String id, java.lang.String name, java.net.URI uriStartString, java.net.URI remoteZipFile, java.lang.String path, java.lang.String version, java.lang.String _case, java.lang.String requires, java.lang.String format, java.lang.String obsolete, java.lang.String installOnUpdate, java.lang.String hidden) Instantiates a new static catalog entry.

Method Summary

Modifier and Type	Method and Description
int	compareTo(RSRemoteCatalogResolver.StaticCatalogEntry o) Compare to.
java.util.Iterator<java.util.Collection<java.net.URI>>	entryPointsIterator() Returns an iterator over URIs that are entry points.
boolean	equals(java.lang.Object obj) Equals.
java.lang.String	getCase() Gets the case.
RSRemoteCatalogResolver.CatalogFormat	getFormat() Gets the format.
java.lang.String	getId() Gets the id.
java.lang.String	getName() Gets the name.
java.lang.String	getPath() Gets the path.
java.net.URI	getRemoteZipFile() Gets the remote zip file.
java.lang.String	getRequires() Access to the requires field.
java.net.URI	getUriStartString() Gets the uri start string.
java.lang.Object	getVersion() Gets the version.
int	hashCode() Hash code.
boolean	isHidden() Checks if is hidden.
boolean	isInstallOnUpdate() Checks if is install on update.
boolean	isObsolete() Checks if is obsolete.
java.util.Iterator<java.net.URI>	iterator() Returns an iterator over remote files.
boolean	matches(java.net.URI u) Matches.

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticCatalogEntry

public StaticCatalogEntry(java.lang.String id,
                          java.lang.String name,
                          java.net.URI uriStartString,
                          java.net.URI remoteZipFile,
                          java.lang.String path,
                          java.lang.String version,
                          java.lang.String _case,
                          java.lang.String requires,
                          java.lang.String format,
                          java.lang.String obsolete,
                          java.lang.String installOnUpdate,
                          java.lang.String hidden)

Instantiates a new static catalog entry.

Parameters:

id - the id

name - the name

uriStartString - the uri start string

remoteZipFile - the remote zip file

path - the path

version - the version

_case - the _case

requires - the requires

format - the format

obsolete - the obsolete

installOnUpdate - if true, and the taxonomy is not installed installation will be forced

hidden - the hidden

Method Detail

getFormat

public RSRemoteCatalogResolver.CatalogFormat getFormat()

Gets the format.

Returns:

the format

isObsolete

public boolean isObsolete()

Checks if is obsolete.

Returns:

the obsolete

isHidden

public boolean isHidden()

Checks if is hidden.

Returns:

the hidden

getName

public java.lang.String getName()

Gets the name.

Returns:

the name

getRemoteZipFile

public java.net.URI getRemoteZipFile()

Gets the remote zip file.

Returns:

the remoteZipFile

getUriStartString

public java.net.URI getUriStartString()

Gets the uri start string.

Returns:

the uriStartString

getPath

public java.lang.String getPath()

Gets the path.

Returns:

the path

getCase

public java.lang.String getCase()

Gets the case.

Returns:

the _case

getVersion

public java.lang.Object getVersion()

Gets the version.

Returns:

the version

matches

public boolean matches(java.net.URI u)

Matches.

Parameters:

u - the u

Returns:

true, if successful

getId

public java.lang.String getId()

Gets the id. This is the ID in the XBRLStaticCatalog2.xml file

Returns:

the id

compareTo

public int compareTo(RSRemoteCatalogResolver.StaticCatalogEntry o)

Compare to.

Specified by:

compareTo in interface java.lang.Comparable<RSRemoteCatalogResolver.StaticCatalogEntry>

Parameters:

o - the o

Returns:

the int

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

isInstallOnUpdate

public boolean isInstallOnUpdate()

Checks if is install on update.

Returns:

true if there is an attribute on the entry indicating that the package shall be always installed automatically

getRequires

public java.lang.String getRequires()

Access to the requires field.

Returns:

the requires

iterator

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

Returns an iterator over remote files.

Returns:

the iterator

entryPointsIterator

public java.util.Iterator<java.util.Collection<java.net.URI>> entryPointsIterator()

Returns an iterator over URIs that are entry points. Entry points exists only in packages created under the Taxonomy Packages Specification so when this method is called on a StaticCatalogEntry that is not of that type the empty iterator is returned

Returns:

iterator over a collection of URIs (there is normally just one URI) representing the declared entry points