com.batavia.xbrl.instance
Interface Entity

All Superinterfaces:

java.lang.Comparable, ComparablePart, ContextElement, IdKeeper, InstanceElement, java.io.Serializable, org.relaxng.datatype.ValidationContext, XbrlElement, XmlElement, XmlParticle

public interface Entity
extends ContextElement

The entity element documents the entity (business, government department, individual, etc.) that fact describes. The entity element is required content of the context element. The entity element MUST contain an identifier element and MAY contain a segment element.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

Identifier	createIdentifier(java.lang.String scheme, java.lang.String id) Create a child Identifier and add it to the XbrlElement.
Segment	createSegment() Create a child Segment and add it to the XbrlElement.
Identifier	getIdentifier() Get the Identifier for this Entity.
Segment	getSegment() Get the segment for this entity.
void	setIdentifier(Identifier identifier) Set a new Identifier for this Entity.
void	setSegment(Segment segment) Set the segment for this entity.

Methods inherited from interface com.batavia.xbrl.instance.InstanceElement

createChildElement, getAllowedSubstitutions, getChildren, getMyDiscoverableTaxonomySet, getXbrlRoot

Methods inherited from interface com.batavia.xbrl.XbrlElement

addChild, fromXbrl, getXbrlElementNameSpace, removeChild, toXbrlStream, toXbrlString

Methods inherited from interface com.batavia.xml.XmlElement

addAttribute, addChild, addChildren, addComment, addMessage, addNameSpace, clearMessages, fromXml, getAttribute, getAttribute, getAttributeSet, getChild, getChildren, getChildren, getDefaultNameSpace, getDocumentHref, getErrorMessage, getFullyQualifiedNameValue, getMappedChildren, getMessages, getName, getNameSpace, getNameSpacePrefixes, getNameSpaces, getPointedElement, getValidXmlBase, getValue, getXmlElementNameSpace, getXmlRoot, isValid, moveChild, removeAttribute, removeChild, resolvePointedValue, resolvePointedXmlParticle, setAttributeValue, setChildren, setDocumentHref, setErrorMessage, setInit, setName, setTargetNameSpace, setValue, toXml, toXml, toXmlStream, toXmlString, toXstringBuffer, validate

Methods inherited from interface com.batavia.xml.XmlParticle

destroy, getBaseUri, getParent, getPrefix, getTargetNameSpace, isBoolean, isNumber, p_equal, resolveNamespacePrefix, setParent, toXstring

Methods inherited from interface com.batavia.xml.ComparablePart

c_equal, identical, s_equal, u_equal, v_equal, x_equal

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.relaxng.datatype.ValidationContext

isNotation, isUnparsedEntity

Methods inherited from interface com.batavia.xml.IdKeeper

addIdHolder, getHolder, removeIdHolder

Method Detail

createSegment

Segment createSegment()

Create a child Segment and add it to the XbrlElement. Return it so that the caller can influence the childs value/children/attributes

Returns:

Segment new child that is already added to parent when returned

createIdentifier

Identifier createIdentifier(java.lang.String scheme,
                            java.lang.String id)

Create a child Identifier and add it to the XbrlElement. Return it so that the caller can influence the childs value/children/attributes

Returns:

Identifier new child that is already added to parent when returned

getIdentifier

Identifier getIdentifier()

Get the Identifier for this Entity.

Returns:

Identifier

setIdentifier

void setIdentifier(Identifier identifier)

Set a new Identifier for this Entity.

Parameters:

identifier -

getSegment

Segment getSegment()

Get the segment for this entity.

Returns:

Segment

setSegment

void setSegment(Segment segment)

Set the segment for this entity.

Parameters:

segment -