com.ihr.xbrl.pojo

Class XBRLDBAccessor

java.lang.Object

com.ihr.xbrl.pojo.XBRLDBAccessor

public class XBRLDBAccessor
extends java.lang.Object

Methods to query the database for the existence of documents os other objects.

Author:

Ignacio

Field Summary

Fields

Modifier and Type	Field and Description
org.apache.log4j.Logger	log The log.
static java.util.Comparator<XBRLUnit>	unitDisambiguator

Constructor Summary

Constructors

Constructor and Description
XBRLDBAccessor(org.hibernate.Session session, DbUtil.Database databaseType) Creates an instance of the XBRLDBAcessor object to query the database for the existence of objects.

Method Summary

Modifier and Type	Method and Description
void	endArcrole(XBRLArcroleType role)
void	endDocument(java.net.URI element)
void	endRole(XBRLRoleType role)
XBRLUsedOn	generate(XBRLUsedOn dtsOn, org.hibernate.Session session, XBRLRoleArcroleType role, java.util.List<java.lang.Object> createdObjects) Generate.
DbUtil.Database	getDatabaseType() Gets the database type.
java.util.Collection<QName>	qnameCollection(java.util.Collection<javax.xml.namespace.QName> inputCol, org.hibernate.Session typeSession, java.util.List<java.lang.Object> createdObjects)
XBRLArcroleType	queryArcrole(XBRLArcroleType uri, org.hibernate.Session typeSession, java.util.List<java.lang.Object> createdObjects) Query arcrole.
XBRLItem	queryConceptItem(java.lang.Long id) Query concept item.
XBRLTuple	queryConceptTuple(java.lang.Long id) Query concept tuple.
XBRLDocument	queryDocument(java.net.URI documentURI, org.hibernate.Session typeSession, java.util.List<java.lang.Object> createdObjects) Query document.
XBRLInstance	queryDocument(XBRLInstance instance, org.hibernate.Session typeSession, java.util.List<java.lang.Object> createdObjects) Query the database for the existence of an XBRLInstance document.
XBRLLinkbase	queryDocument(XBRLLinkbase linkbase, org.hibernate.Session typeSession, java.util.List<java.lang.Object> createdObjects) Query the database for the existence of an XBRLLinkbase document.
XBRLTaxonomy	queryDocument(XBRLTaxonomy taxonomy, org.hibernate.Session typeSession, java.util.List<java.lang.Object> createdObjects) Query the database for the existence of an XBRLTaxonomy document.
boolean	queryDocumentStored(java.net.URI uri, org.hibernate.Session dbSession) This is a faster mechanism to check that a document has been stored to the database or not using the document URI.
XBRLFactProperty	queryFactProperty(XBRLFactItem fact, int container, XMLFragment property) Search on the database for a property in the XBRLFactProperty table that matches the selection criteria according with the primary key that is created using the fact ID, the container and the property node ID.
Namespace	queryNamespace(javax.xml.namespace.QName q, org.hibernate.Session typeSession, java.util.List<java.lang.Object> createdObjects) Query namespace.
QName	queryQName(javax.xml.namespace.QName q, org.hibernate.Session typeSession, java.util.List<java.lang.Object> createdObjects) Query q name.
XBRLRoleType	queryRole(XBRLRoleType role, org.hibernate.Session typeSession, java.util.List<java.lang.Object> createdObjects) Query role.
XBRLUnit	queryUnit(XBRLUnit unit, org.hibernate.Session typeSession, java.util.List<java.lang.Object> createdObjects)

Methods inherited from class java.lang.Object

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

Field Detail

log

public org.apache.log4j.Logger log

The log.

unitDisambiguator

public static java.util.Comparator<XBRLUnit> unitDisambiguator

Constructor Detail

XBRLDBAccessor

public XBRLDBAccessor(org.hibernate.Session session,
                      DbUtil.Database databaseType)

Creates an instance of the XBRLDBAcessor object to query the database for the existence of objects.

This constructor can be used only for querying documents. Not QNames and not for storing new data.

Parameters:

session - the session

databaseType - the database type

Method Detail

queryDocument

public XBRLInstance queryDocument(XBRLInstance instance,
                                  org.hibernate.Session typeSession,
                                  java.util.List<java.lang.Object> createdObjects)
                           throws XBRLPojoGenerationException

Query the database for the existence of an XBRLInstance document.

Parameters:

instance - XBRLInstance document in the RS object model.

Returns:

instance in the POJO object model from the database if found or null if not found

Throws:

XBRLPojoGenerationException

queryDocument

public XBRLLinkbase queryDocument(XBRLLinkbase linkbase,
                                  org.hibernate.Session typeSession,
                                  java.util.List<java.lang.Object> createdObjects)
                           throws XBRLPojoGenerationException

Query the database for the existence of an XBRLLinkbase document.

Parameters:

linkbase - XBRLLinkbase document in the RS object model.

Returns:

linkbase in the POJO object model from the database if found or null if not found

Throws:

XBRLPojoGenerationException

queryDocument

public XBRLTaxonomy queryDocument(XBRLTaxonomy taxonomy,
                                  org.hibernate.Session typeSession,
                                  java.util.List<java.lang.Object> createdObjects)
                           throws XBRLPojoGenerationException

Query the database for the existence of an XBRLTaxonomy document.

Parameters:

taxonomy - XBRLTaxonomy document in the RS object model.

Returns:

taxonomy in the POJO object model from the database if found or null if not found

Throws:

XBRLPojoGenerationException

queryDocument

public XBRLDocument queryDocument(java.net.URI documentURI,
                                  org.hibernate.Session typeSession,
                                  java.util.List<java.lang.Object> createdObjects)
                           throws XBRLPojoGenerationException

Query document.

Parameters:

documentURI - the URI of a document

Returns:

the XBRLDocument from the database

Throws:

XBRLPojoGenerationException

endDocument

public void endDocument(java.net.URI element)

queryConceptItem

public XBRLItem queryConceptItem(java.lang.Long id)

Query concept item.

Parameters:

id - the id

Returns:

the XBRL item

queryConceptTuple

public XBRLTuple queryConceptTuple(java.lang.Long id)

Query concept tuple.

Parameters:

id - the id

Returns:

the XBRL tuple

queryQName

public QName queryQName(javax.xml.namespace.QName q,
                        org.hibernate.Session typeSession,
                        java.util.List<java.lang.Object> createdObjects)
                 throws XBRLPojoGenerationException

Query q name.

Parameters:

q - the q

Returns:

the com.ihr.xbrl.pojo. q name

Throws:

XBRLPojoGenerationException

queryUnit

public XBRLUnit queryUnit(XBRLUnit unit,
                          org.hibernate.Session typeSession,
                          java.util.List<java.lang.Object> createdObjects)
                   throws XBRLPojoGenerationException

Parameters:

unit -

Returns:

Throws:

XBRLPojoGenerationException

org.hibernate.HibernateException

qnameCollection

public java.util.Collection<QName> qnameCollection(java.util.Collection<javax.xml.namespace.QName> inputCol,
                                                   org.hibernate.Session typeSession,
                                                   java.util.List<java.lang.Object> createdObjects)
                                            throws XBRLPojoGenerationException

Throws:

XBRLPojoGenerationException

queryNamespace

public Namespace queryNamespace(javax.xml.namespace.QName q,
                                org.hibernate.Session typeSession,
                                java.util.List<java.lang.Object> createdObjects)
                         throws XBRLPojoGenerationException

Query namespace.

Parameters:

q - the q

Returns:

the namespace

Throws:

XBRLPojoGenerationException

queryRole

public XBRLRoleType queryRole(XBRLRoleType role,
                              org.hibernate.Session typeSession,
                              java.util.List<java.lang.Object> createdObjects)
                       throws XBRLPojoGenerationException

Query role.

Parameters:

uri - the uri

Returns:

the com.ihr.xbrl.pojo. xbrl role type

Throws:

XBRLPojoGenerationException

endRole

public void endRole(XBRLRoleType role)

Parameters:

role -

generate

public XBRLUsedOn generate(XBRLUsedOn dtsOn,
                           org.hibernate.Session session,
                           XBRLRoleArcroleType role,
                           java.util.List<java.lang.Object> createdObjects)
                    throws XBRLPojoGenerationException

Generate.

Parameters:

dtsOn - the dts on

Returns:

XBRLUsedOn

Throws:

XBRLPojoGenerationException - the XBRL pojo generation exception

queryArcrole

public XBRLArcroleType queryArcrole(XBRLArcroleType uri,
                                    org.hibernate.Session typeSession,
                                    java.util.List<java.lang.Object> createdObjects)
                             throws XBRLPojoGenerationException

Query arcrole.

Parameters:

uri - the uri

Returns:

the com.ihr.xbrl.pojo. xbrl arcrole type

Throws:

XBRLPojoGenerationException

endArcrole

public void endArcrole(XBRLArcroleType role)

Parameters:

role -

getDatabaseType

public DbUtil.Database getDatabaseType()

Gets the database type.

Returns:

the databaseType

queryFactProperty

public XBRLFactProperty queryFactProperty(XBRLFactItem fact,
                                          int container,
                                          XMLFragment property)

Search on the database for a property in the XBRLFactProperty table that matches the selection criteria according with the primary key that is created using the fact ID, the container and the property node ID.

One may think the container should not be part of the key, as the property is an XMLFragment that belongs to a specific container (segment or scenario), we have included the container as a specific property in order to allow virtual properties to be explicitly declared in the database. Virtual properties may be an XMLFragment node in its own and be at no container at all (default values for explicit dimensions are an example of this).

Parameters:

fact - the fact

container - the container

property - the property

Returns:

the XBRL fact property

queryDocumentStored

public boolean queryDocumentStored(java.net.URI uri,
                                   org.hibernate.Session dbSession)

This is a faster mechanism to check that a document has been stored to the database or not using the document URI. This method does not create the surrounding XBRLDocument but just checks for the existence of the key in the documents table.

This is an optimization to avoid the cost of doing a queryDocument(...) != null that obtains all document content from the database when that content is not needed

Parameters:

uri - the document uri as stored in the database

dbSession - the session to use for the query

Returns:

false if the document is not stored (there is no key in the documents table)