com.batavia.xbrl.taxonomy
Interface Concept

All Superinterfaces:

java.lang.Comparable, ComparablePart, Declaration, IdHolder, IdKeeper, RegularSchemaElement, java.io.Serializable, TaxonomyElement, org.relaxng.datatype.ValidationContext, XbrlElement, XmlElement, XmlParticle

All Known Subinterfaces:

Item, Tuple

public interface Concept
extends TaxonomyElement, IdHolder, Declaration

Concepts are defined in taxonomy schemas.

Each concept defined in a taxonomy schema is uniquely identified by an element’s syntax definition in the taxonomy schema. To correspond to a concept definition, an XML Schema element definition has to specify the element’s name, a substitution group, and type. All element names MUST be unique within a given taxonomy schema.

The element MUST be in the substitution group for the XBRL item element or the XBRL tuple element. The element MAY also include any of the other XML Schema attributes that can be used on an element’s syntax definition, including abstract and nillable.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

void	createExtraSibblings(int nr, Fact sibbling, InstanceElement parentForSibblings, Xbrl instanceRoot, boolean includeDefaultValues)
Fact	createInferredFact(InstanceElement parent, Xbrl aRoot) create a Fact and populate it except for its value for the purpose of inferring an instance fact for paasing a conformnace test
XmlAttribute	getAbstractAttribute()
java.util.List	getAncestors()
XmlAttribute	getBalance()
java.util.Map	getCalculationMap() Get the Map that containes the calculations for this concept
XbrlType	getConceptType() Get the concept type for this concept.
XmlAttribute	getId()
Label	getLabel(java.lang.String prefRole, java.lang.String prefLanguage, DiscoverableTaxonomySet dts) get the Label for this Concept based on the preffered role uri and the preffered language code.
java.util.List	getLabels(java.lang.String prefRole, java.lang.String prefLanguage, DiscoverableTaxonomySet dts)
int	getMaxOccurs()
XmlAttribute	getNameAttribute()
FullyQualifiedName	getNameForTargetNamespace() Get the name of this concept for its (parents) target namespace including a prefix
FullyQualifiedName	getNameForTargetNamespace(XbrlElement theElementItsFor) Get the name of this concept for its (parents) target namespace including a prefix.
XmlAttribute	getNillable()
XmlAttribute	getPeriodType()
Label	getPrefLabelAndLangOnly(java.lang.String prefRole, java.lang.String prefLanguage, DiscoverableTaxonomySet dts)
java.util.List	getReferences(DiscoverableTaxonomySet dts)
XmlAttribute	getSubstitutionGroup()
XmlAttribute	getType()
boolean	isAbstract()
boolean	isOptional()
void	setAbstractAttribute(XmlAttribute abstractAttribute)
void	setBalance(XmlAttribute balance)
void	setId(XmlAttribute id)
void	setMaxOccurs(int maxOccurs)
void	setNameAttribute(XmlAttribute nameAttribute)
void	setNillable(XmlAttribute nillable)
void	setOptional(boolean optional)
void	setPeriodType(XmlAttribute periodType)
void	setSubstitutionGroup(XmlAttribute substitutionGroup)
void	setType(XmlAttribute type)
java.lang.String	toString() Create string for debug
boolean	validate(XmlElement xmlElement, ValidationDocument msgs) Validate this xbrl part (of the instance and/or its supporting discoverable taxonomy set) and add messages on any problem to the given XbrlValidationMessages collection.

Methods inherited from interface com.batavia.xbrl.taxonomy.type.Declaration

createContents, getAncestor, getXmlType, isInSubstitutionGroup, isPresent, validate

Method Detail

getConceptType

XbrlType getConceptType()

Get the concept type for this concept. The concept type is used to validate instance facts that are reported on this concept

Returns:

XbrlConceptType

getCalculationMap

java.util.Map getCalculationMap()

Get the Map that containes the calculations for this concept

Returns:

map

toString

java.lang.String toString()

Create string for debug

Overrides:

toString in class java.lang.Object

Returns:

String

createInferredFact

Fact createInferredFact(InstanceElement parent,
                        Xbrl aRoot)

create a Fact and populate it except for its value for the purpose of inferring an instance fact for paasing a conformnace test

Parameters:

parent -

aRoot -

Returns:

getAbstractAttribute

XmlAttribute getAbstractAttribute()

Returns:

Returns the abstractAttribute.

setAbstractAttribute

void setAbstractAttribute(XmlAttribute abstractAttribute)

Parameters:

abstractAttribute - The abstractAttribute to set.

getBalance

XmlAttribute getBalance()

Returns:

Returns the balance.

setBalance

void setBalance(XmlAttribute balance)

Parameters:

balance - The balance to set.

getId

XmlAttribute getId()

Specified by:

getId in interface IdHolder

Returns:

Returns the id.

setId

void setId(XmlAttribute id)

Parameters:

id - The id to set.

getNillable

XmlAttribute getNillable()

Returns:

Returns the nillable.

setNillable

void setNillable(XmlAttribute nillable)

Parameters:

nillable - The nillable to set.

getPeriodType

XmlAttribute getPeriodType()

Returns:

Returns the periodType.

setPeriodType

void setPeriodType(XmlAttribute periodType)

Parameters:

periodType - The periodType to set.

getSubstitutionGroup

XmlAttribute getSubstitutionGroup()

Specified by:

getSubstitutionGroup in interface Declaration

Returns:

Returns the substitutionGroup.

setSubstitutionGroup

void setSubstitutionGroup(XmlAttribute substitutionGroup)

Specified by:

setSubstitutionGroup in interface Declaration

Parameters:

substitutionGroup - The substitutionGroup to set.

getType

XmlAttribute getType()

Returns:

Returns the type.

setType

void setType(XmlAttribute type)

Parameters:

type - The type to set.

getNameAttribute

XmlAttribute getNameAttribute()

Returns:

Returns the nameAttribute.

setNameAttribute

void setNameAttribute(XmlAttribute nameAttribute)

Parameters:

nameAttribute - The nameAttribute to set.

getNameForTargetNamespace

FullyQualifiedName getNameForTargetNamespace()

Get the name of this concept for its (parents) target namespace including a prefix

Specified by:

getNameForTargetNamespace in interface Declaration

Returns:

FullyQualifiedName

getNameForTargetNamespace

FullyQualifiedName getNameForTargetNamespace(XbrlElement theElementItsFor)

Get the name of this concept for its (parents) target namespace including a prefix. Use the params' mappings of prefixes to namespace uris to determine the preferred namespace.

Specified by:

getNameForTargetNamespace in interface Declaration

Parameters:

XbrlElement - the name is created for

Returns:

FullyQualifiedName

isAbstract

boolean isAbstract()

Specified by:

isAbstract in interface Declaration

getMaxOccurs

int getMaxOccurs()

Returns:

Returns the maxOccurs.

setMaxOccurs

void setMaxOccurs(int maxOccurs)

Parameters:

maxOccurs - The maxOccurs to set.

isOptional

boolean isOptional()

Returns:

Returns the optional.

setOptional

void setOptional(boolean optional)

Parameters:

optional - The optional to set.

createExtraSibblings

void createExtraSibblings(int nr,
                          Fact sibbling,
                          InstanceElement parentForSibblings,
                          Xbrl instanceRoot,
                          boolean includeDefaultValues)

getReferences

java.util.List getReferences(DiscoverableTaxonomySet dts)

getLabel

Label getLabel(java.lang.String prefRole,
               java.lang.String prefLanguage,
               DiscoverableTaxonomySet dts)

get the Label for this Concept based on the preffered role uri and the preffered language code.

Parameters:

prefRole - uri

prefLanguage - code like "en"

Returns:

label

getPrefLabelAndLangOnly

Label getPrefLabelAndLangOnly(java.lang.String prefRole,
                              java.lang.String prefLanguage,
                              DiscoverableTaxonomySet dts)

getLabels

java.util.List getLabels(java.lang.String prefRole,
                         java.lang.String prefLanguage,
                         DiscoverableTaxonomySet dts)

validate

boolean validate(XmlElement xmlElement,
                 ValidationDocument msgs)

Validate this xbrl part (of the instance and/or its supporting discoverable taxonomy set) and add messages on any problem to the given XbrlValidationMessages collection.

Specified by:

validate in interface Declaration

Parameters:

msgs - The messages that indicate the problems with the instance and or its supporting taxonomy set

Returns:

true if there ar no problems with this XbrlElementImpl

getAncestors

java.util.List getAncestors()