com.ihr.xbrl.filters

Class DimensionFilter

java.lang.Object

com.ihr.xbrl.filters.DimensionFilter

All Implemented Interfaces:

XBRLFilterInterface

public class DimensionFilter
extends java.lang.Object
implements XBRLFilterInterface

The Class DimensionFilter.

Author:

Ignacio

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAsString() Returns the string representation of this filter.
javax.xml.namespace.QName	getDimension() Gets the dimension.
static java.lang.String	getMainFilterArgument(java.lang.String text) If the function isTypeOfFilter returns true, some filters are very simple and only requires one single argument to be passed in (a text string). for those cases, this function should return the filter argument.
java.lang.String	getTable() Returns the name of a new table to be added to the filter query.
java.lang.String	getTableWhere() Returns the where clause that joins the table with the existing XBRLFactItems table.
java.lang.String	getWhere() Returns the text of the where clause (without the "and" clause) there is only one if the XBRLFilterInterface.hasWhereClause() function has returned true.
boolean	hasTables() This shall return true if the filter requires a new table to be inserted in the query.
boolean	hasWhereClause() Returns true if the filter is able to provide a where clause to the query statement.
static boolean	isTypeOfFilter(java.lang.String text) Checks if is type of filter.
static XBRLFilterInterface	newDimensionFilter(javax.xml.namespace.QName dimName, FContext fc, org.hibernate.Session session) New dimension filter.
static XBRLFilterInterface	newDimensionFilter(java.lang.String filter, org.hibernate.Session session) New dimension filter.
void	removeFactsNotPass(java.util.List<?> lst) Removes the facts not pass.
org.hibernate.Query	setParameters(org.hibernate.Query q) Fills in the parameter values for this query in the where clause.

Methods inherited from class java.lang.Object

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

Method Detail

getAsString

public java.lang.String getAsString()

Description copied from interface: XBRLFilterInterface

Returns the string representation of this filter.

Specified by:

getAsString in interface XBRLFilterInterface

Returns:

the as string

getWhere

public java.lang.String getWhere()
                          throws java.lang.IllegalAccessException

Description copied from interface: XBRLFilterInterface

Returns the text of the where clause (without the "and" clause) there is only one if the XBRLFilterInterface.hasWhereClause() function has returned true.

When preparing the returned string, f is the XBRLFact pojo instance other classes may use in the where clause

Specified by:

getWhere in interface XBRLFilterInterface

Returns:

the where

Throws:

java.lang.IllegalAccessException - if the class does not implements this method

hasWhereClause

public boolean hasWhereClause()

Description copied from interface: XBRLFilterInterface

Returns true if the filter is able to provide a where clause to the query statement.

Specified by:

hasWhereClause in interface XBRLFilterInterface

Returns:

boolean

removeFactsNotPass

public void removeFactsNotPass(java.util.List<?> lst)

Description copied from interface: XBRLFilterInterface

Removes the facts not pass.

Specified by:

removeFactsNotPass in interface XBRLFilterInterface

Parameters:

lst - the lst

setParameters

public org.hibernate.Query setParameters(org.hibernate.Query q)
                                  throws java.lang.IllegalAccessException

Description copied from interface: XBRLFilterInterface

Fills in the parameter values for this query in the where clause.

Specified by:

setParameters in interface XBRLFilterInterface

Parameters:

q - the query without the parameters filled in.

Returns:

Query with the parameters filled in

Throws:

java.lang.IllegalAccessException - if the class does not implements this method

newDimensionFilter

public static XBRLFilterInterface newDimensionFilter(javax.xml.namespace.QName dimName,
                                                     FContext fc,
                                                     org.hibernate.Session session)

New dimension filter.

Parameters:

dimName - the dim name

fc - the fc

session - the session

Returns:

the XBRL filter interface

isTypeOfFilter

public static boolean isTypeOfFilter(java.lang.String text)

Checks if is type of filter.

Parameters:

text - the text

Returns:

true, if is type of filter

newDimensionFilter

public static XBRLFilterInterface newDimensionFilter(java.lang.String filter,
                                                     org.hibernate.Session session)

New dimension filter.

Parameters:

filter - the filter

session - the session

Returns:

the XBRL filter interface

getMainFilterArgument

public static java.lang.String getMainFilterArgument(java.lang.String text)

If the function isTypeOfFilter returns true, some filters are very simple and only requires one single argument to be passed in (a text string). for those cases, this function should return the filter argument.

Parameters:

text - the text

Returns:

the main filter argument

getDimension

public javax.xml.namespace.QName getDimension()

Gets the dimension.

Returns:

the dimension

hasTables

public boolean hasTables()

Description copied from interface: XBRLFilterInterface

This shall return true if the filter requires a new table to be inserted in the query. If the return value is true, getTable() and getTableWhere() will be called to obtain the required values.

Specified by:

hasTables in interface XBRLFilterInterface

Returns:

boolean value

getTable

public java.lang.String getTable()
                          throws java.lang.IllegalAccessException

Description copied from interface: XBRLFilterInterface

Returns the name of a new table to be added to the filter query.

Specified by:

getTable in interface XBRLFilterInterface

Returns:

String with the name of the table to be added and alias for the table

Throws:

java.lang.IllegalAccessException - if the method is called for a filter that does not adds tables

getTableWhere

public java.lang.String getTableWhere()
                               throws java.lang.IllegalAccessException

Description copied from interface: XBRLFilterInterface

Returns the where clause that joins the table with the existing XBRLFactItems table.

Specified by:

getTableWhere in interface XBRLFilterInterface

Returns:

String with the where clause

Throws:

java.lang.IllegalAccessException - if the method is called on a filter that does not adds tables