com.rs.xbrl.instructions.formula

Class QNameOrExpression

java.lang.Object

com.rs.xbrl.instructions.formula.QNameOrExpression

public class QNameOrExpression
extends java.lang.Object

Encapsulates the information relative to a choice to generate a QName used in the formula specification and that comes from either a static QName, an XPath expression or a static QName that refers to a variable rather than a QName itself. This information is used to generate the surrounding XML. The class also contains

Author:

Ignacio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QNameOrExpression.Type The Enum Type.

Constructor Summary

Constructors

Constructor and Description
QNameOrExpression(javax.xml.namespace.QName value) Instantiates a new q name or expression.
QNameOrExpression(java.lang.String value) Instantiates a new q name or expression.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getArcrole() Gets the arcrole.
java.lang.String	getAxis() Gets the token.
java.lang.String	getExpression() Gets the expression.
java.lang.String	getLinkRole() Gets the link role.
javax.xml.namespace.QName	getQName() Gets the q name.
QNameOrExpression.Type	getType() Gets the type.
boolean	isExtended() Check if this member contains linkrole, arcrole or token and returns true if that is the case note, in order to generate a resource, it is required to provide all this values.
static QNameOrExpression	readQcE(ExcelSheetPoint sp, GenerationContext gc) Read from the excel sheet point indicated in sp parameter either a QName or an XPath expression where the QName could be a concept definition
static QNameOrExpression	readQcEV(ExcelSheetPoint sp, GenerationContext gc) Read from the excel sheet point indicated in sp parameter either a QName, an XPath expression or a variable name where the QName could be a concept definition
static QNameOrExpression	readQnE(ExcelSheetPoint sp, GenerationContext gc) Read from the excel sheet point indicated in sp parameter either a QName or an XPath expression where the QName might NOT be a concept definition
static QNameOrExpression	readQnEV(ExcelSheetPoint sp, GenerationContext gc) Read from the excel sheet point indicated in sp parameter either a QName, an XPath expression or a variable name where the QName might NOT be a concept definition
void	setArcrole(java.lang.String arcrole) Sets the arcrole.
void	setAxis(java.lang.String axis) Sets the token.
void	setLinkRole(java.lang.String linkRole) Sets the link role.
void	setVariable() Sets the type to variable.

Methods inherited from class java.lang.Object

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

Constructor Detail

QNameOrExpression

public QNameOrExpression(javax.xml.namespace.QName value)

Instantiates a new q name or expression.

Parameters:

value - the value

QNameOrExpression

public QNameOrExpression(java.lang.String value)

Instantiates a new q name or expression.

Parameters:

value - the value

Method Detail

readQcE

public static QNameOrExpression readQcE(ExcelSheetPoint sp,
                                        GenerationContext gc)
                                 throws SheetPointException

Read from the excel sheet point indicated in sp parameter either a QName or an XPath expression where the QName could be a concept definition

Parameters:

sp - the Excel Sheet Point to use

gc - the XBRL Generation Context

Returns:

an instance of QNameOrExpression class

Throws:

SheetPointException - the sheet point exception

readQnE

public static QNameOrExpression readQnE(ExcelSheetPoint sp,
                                        GenerationContext gc)
                                 throws SheetPointException

Read from the excel sheet point indicated in sp parameter either a QName or an XPath expression where the QName might NOT be a concept definition

Parameters:

sp - the Excel Sheet Point to use

gc - the XBRL Generation Context

Returns:

an instance of QNameOrExpression class

Throws:

SheetPointException - the sheet point exception

readQcEV

public static QNameOrExpression readQcEV(ExcelSheetPoint sp,
                                         GenerationContext gc)
                                  throws SheetPointException

Read from the excel sheet point indicated in sp parameter either a QName, an XPath expression or a variable name where the QName could be a concept definition

Parameters:

sp - the Excel Sheet Point to use

gc - the XBRL Generation Context

Returns:

an instance of QNameOrExpression class

Throws:

SheetPointException - the sheet point exception

readQnEV

public static QNameOrExpression readQnEV(ExcelSheetPoint sp,
                                         GenerationContext gc)
                                  throws SheetPointException

Read from the excel sheet point indicated in sp parameter either a QName, an XPath expression or a variable name where the QName might NOT be a concept definition

Parameters:

sp - the Excel Sheet Point to use

gc - the XBRL Generation Context

Returns:

an instance of QNameOrExpression class

Throws:

SheetPointException - the sheet point exception

getType

public QNameOrExpression.Type getType()

Gets the type.

Returns:

the type

getExpression

public java.lang.String getExpression()

Gets the expression.

Returns:

the expression

getQName

public javax.xml.namespace.QName getQName()

Gets the q name.

Returns:

the qname

getLinkRole

public java.lang.String getLinkRole()

Gets the link role.

Returns:

the linkRole

getArcrole

public java.lang.String getArcrole()

Gets the arcrole.

Returns:

the arcrole

getAxis

public java.lang.String getAxis()

Gets the token.

Returns:

the token

setLinkRole

public void setLinkRole(java.lang.String linkRole)

Sets the link role.

Parameters:

linkRole - the linkRole to set

setArcrole

public void setArcrole(java.lang.String arcrole)

Sets the arcrole.

Parameters:

arcrole - the arcrole to set

setAxis

public void setAxis(java.lang.String axis)

Sets the token.

Parameters:

axis - the axis to set

setVariable

public void setVariable()

Sets the type to variable.

isExtended

public boolean isExtended()

Check if this member contains linkrole, arcrole or token and returns true if that is the case

note, in order to generate a resource, it is required to provide all this values. The method returns true if just one of them is not null. It is application responsibility to generate the proper error message if the value set is not complete

Returns:

true if this member contains extended information