com.ihr.xbrl.om.taxonomy
Class XSDAttributeDefinition

java.lang.Object
  com.ihr.xbrl.om.taxonomy.XSDAttributeDefinition

public class XSDAttributeDefinition
extends java.lang.Object

Represents an attribute definition in an XML Schema. This class contains information about the content of the attribute definition in an XML shema type.

Author:

Ignacio

Field Summary

static int	OPTIONAL
static int	PROHIBITED
static int	REQUIRED

Constructor Summary

XSDAttributeDefinition(DTSContainer dts, net.sf.saxon.s9api.XdmNode node)

XSDAttributeDefinition(java.lang.String name, java.lang.String use, javax.xml.namespace.QName type, java.lang.String _default, java.lang.String fixed, java.lang.String form, java.lang.String id, javax.xml.namespace.QName ref)
Creates a new XSDAttribute definition some of the attributes are optional and can be reported using null.

Method Summary

boolean	equals(java.lang.Object obj)
org.jdom.Element	generateElement(org.jdom.Namespace xsNs) Creates an element definition that represents this attribute definition in an XML Schema
java.lang.String	getDefault()
java.lang.String	getFixed()
java.lang.String	getForm()
java.lang.String	getId()
java.lang.String	getName()
javax.xml.namespace.QName	getRef()
javax.xml.namespace.QName	getType()
java.lang.String	getUse()
static java.lang.String	getUse(java.lang.Integer use)
static java.lang.Integer	getUse(java.lang.String strUse)
int	hashCode()
void	setDefault(java.lang.String _default)
void	setFixed(java.lang.String fixed)
void	setForm(java.lang.String form)
void	setId(java.lang.String id)
void	setName(java.lang.String name)
void	setRef(javax.xml.namespace.QName ref)
void	setType(javax.xml.namespace.QName type)
void	setUse(java.lang.String use)

Methods inherited from class java.lang.Object

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

Field Detail

OPTIONAL

public static final int OPTIONAL

See Also:

Constant Field Values

PROHIBITED

public static final int PROHIBITED

See Also:

Constant Field Values

REQUIRED

public static final int REQUIRED

See Also:

Constant Field Values

Constructor Detail

XSDAttributeDefinition

public XSDAttributeDefinition(java.lang.String name,
                              java.lang.String use,
                              javax.xml.namespace.QName type,
                              java.lang.String _default,
                              java.lang.String fixed,
                              java.lang.String form,
                              java.lang.String id,
                              javax.xml.namespace.QName ref)
                       throws XBRLInconsistentDTSException

Creates a new XSDAttribute definition some of the attributes are optional and can be reported using null. Some others are not compatible like ref and name attributes.

Parameters:

name -

use -

type -

_default -

fixed -

form -

id -

ref -

Throws:

XBRLInconsistentDTSException - raised if there are inconsistencies in the definition of the attribute

XSDAttributeDefinition

public XSDAttributeDefinition(DTSContainer dts,
                              net.sf.saxon.s9api.XdmNode node)
                       throws XBRLInconsistentDTSException

Parameters:

dts -

node -

Throws:

XBRLInconsistentDTSException

Method Detail

getUse

public static java.lang.Integer getUse(java.lang.String strUse)
                                throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getUse

public static java.lang.String getUse(java.lang.Integer use)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getName

public java.lang.String getName()

Returns:

the name

setName

public void setName(java.lang.String name)

Parameters:

name - the name to set

getUse

public java.lang.String getUse()

Returns:

the use

setUse

public void setUse(java.lang.String use)

Parameters:

use - the use to set

getType

public javax.xml.namespace.QName getType()

Returns:

the type

setType

public void setType(javax.xml.namespace.QName type)

Parameters:

type - the type to set

getDefault

public java.lang.String getDefault()

Returns:

the _default

setDefault

public void setDefault(java.lang.String _default)

Parameters:

_default - the _default to set

getFixed

public java.lang.String getFixed()

Returns:

the fixed

setFixed

public void setFixed(java.lang.String fixed)

Parameters:

fixed - the fixed to set

getForm

public java.lang.String getForm()

Returns:

the form

setForm

public void setForm(java.lang.String form)

Parameters:

form - the form to set

getId

public java.lang.String getId()

Returns:

the id

setId

public void setId(java.lang.String id)

Parameters:

id - the id to set

getRef

public javax.xml.namespace.QName getRef()

Returns:

the ref

setRef

public void setRef(javax.xml.namespace.QName ref)

Parameters:

ref - the ref to set

generateElement

public org.jdom.Element generateElement(org.jdom.Namespace xsNs)
                                 throws XBRLSerializationException

Creates an element definition that represents this attribute definition in an XML Schema

Parameters:

xsNs - Namespace so no need to define it multiple times

Returns:

Element

Throws:

XBRLSerializationException