com.batavia.xml
Interface XmlAttribute

All Superinterfaces:

java.lang.Comparable, ComparablePart, org.relaxng.datatype.ValidationContext, XmlParticle

public interface XmlAttribute
extends XmlParticle

Interface for all xbrl atributes used in xbrl elements.

Has a FullyQualifiedName. The name does NOT have a defaultnamespace that is taken from the element the attribute resides in. The attributes value can be a FullyQualified name.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

java.lang.String	getDefaultValue() Get the default value for this Attribute.
FullyQualifiedName	getFullyQualifiedNameValue() The value can be a FullyQualified name.
FullyQualifiedName	getName() Get the attributes name.
java.lang.String	getValue() Get the attributes value as a String.
boolean	isBoolean() Determine if this XmlParticleImpl represents a boolean type.
boolean	isDefaultValue() Determine if this attributes value is the defaultvalue.
boolean	isNumber() Determine if this XmlParticleImpl represents a numeric type.
boolean	s_equal(ComparablePart other) Determine if the other is Structure equal to this.
void	setDefaultValue(java.lang.String defaultValue) SetImpl the default value for this atttribute.
void	setName(FullyQualifiedName name) SetImpl the attributes name.
void	setValue(java.lang.String value) SetImpl the attributes value.
boolean	toBoolean() Convert this XmlParticleImpl to a boolean type.
double	toNumber() Convert this XmlParticleImpl to a double type.
java.lang.String	toString() Convert this object to a string representation.
boolean	v_equal(ComparablePart other) Determine if the other is Value equal to this.

Methods inherited from interface com.batavia.xml.XmlParticle

destroy, getBaseUri, getNameSpace, getParent, getPrefix, getTargetNameSpace, p_equal, resolveNamespacePrefix, setParent, toXstring

Methods inherited from interface com.batavia.xml.ComparablePart

c_equal, identical, u_equal, x_equal

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.relaxng.datatype.ValidationContext

isNotation, isUnparsedEntity

Method Detail

getDefaultValue

java.lang.String getDefaultValue()

Get the default value for this Attribute. Only contains a value when set with setDefaultValue();

Returns:

Returns the defaultValue.

getFullyQualifiedNameValue

FullyQualifiedName getFullyQualifiedNameValue()

The value can be a FullyQualified name. If no prefix in the value, then only the name is filled with the found value.

Returns:

Returns the value in a FullyQualifiedName.

getName

FullyQualifiedName getName()

Get the attributes name.

Returns:

Returns the name.

getValue

java.lang.String getValue()

Get the attributes value as a String.

Returns:

Returns the value.

isBoolean

boolean isBoolean()

Determine if this XmlParticleImpl represents a boolean type.

Specified by:

isBoolean in interface XmlParticle

Returns:

true if this XmlParticleImpl represents a boolean type.

isDefaultValue

boolean isDefaultValue()

Determine if this attributes value is the defaultvalue.

Returns:

true if this attributes value is the defaultvalue.

isNumber

boolean isNumber()

Determine if this XmlParticleImpl represents a numeric type.

Specified by:

isNumber in interface XmlParticle

Returns:

true if this XmlParticleImpl represents a numeric type.

s_equal

boolean s_equal(ComparablePart other)

Determine if the other is Structure equal to this.

Specified by:

s_equal in interface ComparablePart

Parameters:

other - another ComparablePart object

Returns:

true if the other is Structure equal to this.

setDefaultValue

void setDefaultValue(java.lang.String defaultValue)

SetImpl the default value for this atttribute.

Parameters:

defaultValue - The defaultValue to set.

setName

void setName(FullyQualifiedName name)

SetImpl the attributes name.

Parameters:

name - The name to set.

setValue

void setValue(java.lang.String value)

SetImpl the attributes value.

Parameters:

value - The value to set.

toBoolean

boolean toBoolean()

Convert this XmlParticleImpl to a boolean type.

Returns:

true if this XmlParticleImpl equals true.

toNumber

double toNumber()

Convert this XmlParticleImpl to a double type.

Returns:

numeric value double when the XmlParticleImpl is numeric.

toString

java.lang.String toString()

Convert this object to a string representation.

Overrides:

toString in class java.lang.Object

Returns:

String representation

v_equal

boolean v_equal(ComparablePart other)

Determine if the other is Value equal to this.

Specified by:

v_equal in interface ComparablePart

Parameters:

other - another ComparablePart object

Returns:

true if the other is Value equal to this.