XMLDocumentURI

java.lang.Object
- com.ihr.xbrl.om.XMLDocumentURI

All Implemented Interfaces:

XBRLDTSDocument, XBRLHasDTSTarget, XBRLValidation, java.io.Serializable

Direct Known Subclasses:

XBRLDocument
```
public class XMLDocumentURI
extends java.lang.Object
implements XBRLDTSDocument, XBRLValidation, XBRLHasDTSTarget, java.io.Serializable
```
This class represents an XML Document that exist in a DTS.
A XMLDocumentURI has a document key, a document URI and a set of child documents.

Author:

Ignacio

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface com.ihr.xbrl.om.XBRLValidation
  XBRLValidation.Direction

Constructor Summary

Constructors
Constructor and Description
`XMLDocumentURI(DTSContainer dts, java.lang.Integer resolvedURI, javax.xml.transform.Source source, boolean bAddToCache, XBRLDTSDocument parent)` Create a DocumentURI from the cache or reading it from the supplied URI if it is not in the cache.
`XMLDocumentURI(DTSContainer dts, java.net.URI resolvedURI, javax.xml.transform.Source source, boolean bAddToCache, XBRLDTSDocument parent)` Create a DocumentURI from the cache or reading it from the supplied URI if it is not in the cache.
`XMLDocumentURI(DTSContainer dts, net.sf.saxon.s9api.XdmNode extendedLinkNode)` For embedded link bases or creation of XBRLDocuments from a XML Source This creator just creates a new XMLFragment and assigns it to the XdmNode received as a parameter.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addChild(XMLDocumentURI child)` Add a new clid to this document list of children.
`void`	`clear()` Clear.
`void`	`delChild(XMLDocumentURI child)` Removes a child document from the list of document children.
`void`	`discoverDTS(XBRLDTSDocument parent)` Discover DTS.
`boolean`	`equals(java.lang.Object obj)` Equals.
`net.sf.saxon.s9api.XdmValue`	`evaluateList(java.lang.String string)` Evaluate list.
`java.net.URI`	`getBase()` Gets the base.
`java.util.Iterator<XMLDocumentURI>`	`getChildren()` Access to the Children property.
`DTSContainer`	`getContainer()` Returns the DTS Container object.
`net.sf.saxon.s9api.XdmNode`	`getDocument()` Returns an XdmNode build from the internal DocumentInfo.
`XBRLDocumentRootNode`	`getDocumentRootNode()` Returns the XMLFragment that is the root node of this XMLDocumentURI.
`java.net.URI`	`getDocumentURI()` Every DocumentURI has a unique URI except embeded linkbases this function returns the document URI or null for embeded linkbases When an instance document is created from nodes, this property value is also null.
`java.lang.Integer`	`getDocumentURICode()` Every DocumentURI has a unique URI except embeded linkbases this function returns the document URI or null for embeded linkbases When an instance document is created from nodes, this property value is also null.
`DTSDiscoveryInfo`	`getDTSDiscoveryInfo()` Gets the DTS discovery info.
`java.lang.Integer`	`getDTSKey()` Gets the DTS key.
`java.lang.String`	`getFriendlyName()` Returns a string description that represents the element content in a form that users can understand.
`java.io.File`	`getLocalFile()` Provides the local file name on the file system even if the surrounding file has systemID of the official URL on the Internet. or null if the source does not have that information stored.
`net.sf.saxon.s9api.XdmNode`	`getOldDocument()` Returns the document obtained from disk or generated by the last call to updateXML This method shall be avoided and is in the process to be eliminated from API.
`java.lang.String`	`getPackageName()` Provides the package name this file has been obtained from.
`java.lang.String`	`getPackageVersion()` Provides version of the package this file has been obtained from.
`java.lang.String`	`getPrefix(java.lang.String namespaceURI)` Returns the prefix String associated to the given URI as defined in this node.
`java.util.Iterator<java.lang.String>`	`getPrefixes(java.lang.String namespaceURI)` Gets the prefixes.
`XBRLValidationReport`	`getValidationReport()` Gets the validation report.
`XBRLDocumentInfo`	`getXBRLDocumentInfo()` Gets the XBRL document info.
`java.lang.String`	`getXPathToRoot()` Returns an XPath 2.0 expression to locate this document's node starting at this document's root This function updates the local namespace context if nodes in the path requires new namespaces to be declared.
`int`	`hashCode()` Hash code.
`void`	`invalidate()` Invalidate.
`boolean`	`invalidate(XBRLValidation.Direction dir)` Invalidate.
`boolean`	`isInDTS(java.net.URI target)` Returns true if the document pointed to by the URI can be discovered in the DTS that would result using this document as the Starting point for DTS Discovery.
`boolean`	`isOnValidation()` Checks if is on validation.
`void`	`setContainer(DTSContainer newContainer)` Changes the dts container of this .
`void`	`setDocumentURICode(java.lang.Integer newCode)` Used internally by the API when one document was loaded in another DTSContainer and is moved to another "compatible" DTSContainer. the documentURI code might not be equal on both DTContainers so it must be adjusted
`void`	`setDTSDiscoveryInfo(DTSDiscoveryInfo ddInfo)` Used when an embedded linkbase is created to inject the internal ddInfo.
`void`	`setDTSKey(java.lang.Integer newValue)` This method is used internally by the API when a document is moved from one DTSContainer to another DTSContainer.
`void`	`setNodeName(javax.xml.namespace.QName nodeName)` Sets a new nodeName to this XMLDocumentURI.
`void`	`setRootNode(XBRLDocumentRootNode instance)` Sets the root node.
`boolean`	`setURI(java.net.URI uri)` Sets the value of the URI of this XMLDocumentURI If the document is in the cache and the supplied URI is not null or is different from the original URI this method throws an XBRLInternalErrorException.
`void`	`setXBRLDocumentInfo(XBRLDocumentInfo documentInfo)` Sets the XBRL document info.
`XBRLValidationReport`	`validate(XBRLPlugInProcessor proc)` Validate.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - XMLDocumentURI
```
public XMLDocumentURI(DTSContainer dts,
                      java.net.URI resolvedURI,
                      javax.xml.transform.Source source,
                      boolean bAddToCache,
                      XBRLDTSDocument parent)
               throws DTSDiscoveryException
```
    Create a DocumentURI from the cache or reading it from the supplied URI if it is not in the cache. Reads the whole document
    
    Parameters:
    
    dts - the DTSContainer object this new object will belongs to
    
    resolvedURI - the resolved URI of document
    
    source - source form where to read the document. If null then the document is obtained form the indicated URI
    
    bAddToCache - true if the document will be added to the cache of documents read
    
    parent - optional (may be null) URL of parent document in order to property create error messages
    
    Throws:
    
    DTSDiscoveryException - if an error occurs
  - XMLDocumentURI
```
public XMLDocumentURI(DTSContainer dts,
                      java.lang.Integer resolvedURI,
                      javax.xml.transform.Source source,
                      boolean bAddToCache,
                      XBRLDTSDocument parent)
               throws DTSDiscoveryException
```
    Create a DocumentURI from the cache or reading it from the supplied URI if it is not in the cache. Reads the whole document
    
    Parameters:
    
    dts - the DTSContainer object this new object will belongs to
    
    resolvedURI - the resolved URI code of document
    
    source - source form where to read the document. If null then the document is obtained form the indicated URI
    
    bAddToCache - true if the document will be added to the cache of documents read
    
    parent - optional (may be null) URL of parent document in order to property create error messages
    
    Throws:
    
    DTSDiscoveryException - if an error occurs
  - XMLDocumentURI
```
public XMLDocumentURI(DTSContainer dts,
                      net.sf.saxon.s9api.XdmNode extendedLinkNode)
```
    For embedded link bases or creation of XBRLDocuments from a XML Source
    This creator just creates a new XMLFragment and assigns it to the XdmNode received as a parameter.
    This creator does not add the DocumentURI to the cache
    This method is also used by the IXBRLProcessor when a new XMLDocumentURI has to be created from the content of the transformed nodes (XBRL Report just extracted) so it can be used to build a new XBRLInstance without using the SchemaAware configuration object. This way, the XBRLInstance is transformed into the schema aware configuration object at a later time when changeConf is normally executed.
    Remember to call setURI(URI) and assign a URI after this instance is created and before calling load and using this XBRLDocumentURI
    
    Parameters:
    
    dts - DTSContainer
    
    extendedLinkNode - is the element in the xl:extended substitution group. The node that identifies the linkbase type
- Method Detail
  - getContainer
```
public DTSContainer getContainer()
```
    Returns the DTS Container object.
    
    Specified by:
    
    getContainer in interface XBRLDTSDocument
    
    Returns:
    
    DTSContainer
  - clear
```
public void clear()
           throws java.lang.Throwable
```
    Clear.
    
    Specified by:
    
    clear in interface XBRLDTSDocument
    
    Throws:
    
    java.lang.Throwable - the throwable
  - getLocalFile
```
public java.io.File getLocalFile()
```
    Provides the local file name on the file system even if the surrounding file has systemID of the official URL on the Internet. or null if the source does not have that information stored.
    
    Returns:
    
    File or null
    
    Since:
    
    2.6.10
  - getPackageName
```
public java.lang.String getPackageName()
```
    Provides the package name this file has been obtained from. It might be null if the source of this document was not a TaxonomyPackage
    
    Returns:
    
    String with document source package name or null
    
    Since:
    
    3.0.6
    
    See Also:
    
    getPackageVersion()
  - getPackageVersion
```
public java.lang.String getPackageVersion()
```
    Provides version of the package this file has been obtained from. It might be null if the source of this document was not a TaxonomyPackage
    
    Returns:
    
    String with document source package version or null
    
    Since:
    
    3.0.6
    
    See Also:
    
    getPackageName()
  - hashCode
```
public int hashCode()
```
    Hash code.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    the int
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Equals.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - the obj
    
    Returns:
    
    true, if successful
  - getPrefix
```
public java.lang.String getPrefix(java.lang.String namespaceURI)
```
    Returns the prefix String associated to the given URI as defined in this node.
    
    Parameters:
    
    namespaceURI - the namespace uri
    
    Returns:
    
    the prefix
  - getPrefixes
```
public java.util.Iterator<java.lang.String> getPrefixes(java.lang.String namespaceURI)
```
    Gets the prefixes.
    
    Parameters:
    
    namespaceURI - the namespace URI
    
    Returns:
    
    the prefixes
  - setURI
```
public boolean setURI(java.net.URI uri)
               throws DTSDiscoveryException
```
    Sets the value of the URI of this XMLDocumentURI If the document is in the cache and the supplied URI is not null or is different from the original URI this method throws an XBRLInternalErrorException.
    TODO: Setting a base uri on a document recalculates all other xlink:href uris in nodes down to the node root. The process must be fired also when xml:base is set on a node that contains sub-nodes.
    
    Parameters:
    
    uri - URI
    
    Returns:
    
    true if URI has really changed (is different)
    
    Throws:
    
    DTSDiscoveryException - the DTS discovery exception
  - getDocumentRootNode
```
public XBRLDocumentRootNode getDocumentRootNode()
```
    Returns the XMLFragment that is the root node of this XMLDocumentURI.
    
    Returns:
    
    the document root node
  - getDocument
```
public net.sf.saxon.s9api.XdmNode getDocument()
```
    Returns an XdmNode build from the internal DocumentInfo.
    
    Returns:
    
    the document
  - getOldDocument
```
public net.sf.saxon.s9api.XdmNode getOldDocument()
```
    Returns the document obtained from disk or generated by the last call to updateXML
    This method shall be avoided and is in the process to be eliminated from API.
    
    Returns:
    
    the old document
  - getDocumentURI
```
public java.net.URI getDocumentURI()
```
    Every DocumentURI has a unique URI except embeded linkbases this function returns the document URI or null for embeded linkbases
    When an instance document is created from nodes, this property value is also null.
    
    Returns:
    
    the URI of this document
  - getDocumentURICode
```
public java.lang.Integer getDocumentURICode()
```
    Every DocumentURI has a unique URI except embeded linkbases this function returns the document URI or null for embeded linkbases
    When an instance document is created from nodes, this property value is also null.
    
    Returns:
    
    the URI of this document
  - setDocumentURICode
```
public void setDocumentURICode(java.lang.Integer newCode)
```
    Used internally by the API when one document was loaded in another DTSContainer and is moved to another "compatible" DTSContainer. the documentURI code might not be equal on both DTContainers so it must be adjusted
    
    Parameters:
    
    newCode - the new document URI code
  - getBase
```
public java.net.URI getBase()
```
    Gets the base.
    
    Returns:
    
    the base
  - getFriendlyName
```
public java.lang.String getFriendlyName()
```
    Returns a string description that represents the element content in a form that users can understand. This method may be overridden by parent classes.
    Remarks, this method may return very long names not suitable for user interface
    
    Returns:
    
    Non empty String. Internationalization is enabled
  - getChildren
```
public java.util.Iterator<XMLDocumentURI> getChildren()
```
    Access to the Children property.
    
    Specified by:
    
    getChildren in interface XBRLHasDTSTarget
    
    Returns:
    
    Iterator<XMLDocumentURI>
  - addChild
```
public boolean addChild(XMLDocumentURI child)
```
    Add a new clid to this document list of children.
    
    Parameters:
    
    child - the child
    
    Returns:
    
    true, if successful
  - delChild
```
public void delChild(XMLDocumentURI child)
```
    Removes a child document from the list of document children.
    
    Parameters:
    
    child - the child
  - discoverDTS
```
public void discoverDTS(XBRLDTSDocument parent)
                 throws DTSDiscoveryException,
                        com.rs.lic.LicenseVerificationException
```
    Discover DTS.
    
    Specified by:
    
    discoverDTS in interface XBRLDTSDocument
    
    Parameters:
    
    parent - the parent
    
    Throws:
    
    DTSDiscoveryException - the DTS discovery exception
    
    com.rs.lic.LicenseVerificationException - the license verification exception
  - getDTSKey
```
public java.lang.Integer getDTSKey()
```
    Gets the DTS key.
    
    Specified by:
    
    getDTSKey in interface XBRLDTSDocument
    
    Returns:
    
    the DTS key
  - setDTSKey
```
public void setDTSKey(java.lang.Integer newValue)
```
    This method is used internally by the API when a document is moved from one DTSContainer to another DTSContainer. The old dtsKey is no longer valid in the new DTSContainer and a new one MUST be created and assigned to the XMLDocumentURI using this method
    
    Parameters:
    
    newValue - the new DTS key
  - isInDTS
```
public boolean isInDTS(java.net.URI target)
```
    Returns true if the document pointed to by the URI can be discovered in the DTS that would result using this document as the Starting point for DTS Discovery.
    
    Parameters:
    
    target - the URI of the XBRL Document to check
    
    Returns:
    
    boolean
  - getValidationReport
```
public XBRLValidationReport getValidationReport()
```
    Gets the validation report.
    
    Specified by:
    
    getValidationReport in interface XBRLValidation
    
    Returns:
    
    the validation report
  - validate
```
public XBRLValidationReport validate(XBRLPlugInProcessor proc)
```
    Validate.
    
    Specified by:
    
    validate in interface XBRLValidation
    
    Parameters:
    
    proc - the proc
    
    Returns:
    
    the XBRL validation report
  - invalidate
```
public void invalidate()
```
    Invalidate.
    
    Specified by:
    
    invalidate in interface XBRLValidation
  - invalidate
```
public boolean invalidate(XBRLValidation.Direction dir)
```
    Invalidate.
    
    Specified by:
    
    invalidate in interface XBRLValidation
    
    Parameters:
    
    dir - the dir
    
    Returns:
    
    true, if successful
  - isOnValidation
```
public boolean isOnValidation()
```
    Checks if is on validation.
    
    Specified by:
    
    isOnValidation in interface XBRLValidation
    
    Returns:
    
    true, if is on validation
  - getDTSDiscoveryInfo
```
public DTSDiscoveryInfo getDTSDiscoveryInfo()
```
    Gets the DTS discovery info.
    
    Returns:
    
    the DTS discovery info
  - setXBRLDocumentInfo
```
public void setXBRLDocumentInfo(XBRLDocumentInfo documentInfo)
```
    Sets the XBRL document info.
    
    Parameters:
    
    documentInfo - the new XBRL document info
  - getXBRLDocumentInfo
```
public XBRLDocumentInfo getXBRLDocumentInfo()
```
    Gets the XBRL document info.
    
    Returns:
    
    the XBRL document info
  - setDTSDiscoveryInfo
```
public void setDTSDiscoveryInfo(DTSDiscoveryInfo ddInfo)
```
    Used when an embedded linkbase is created to inject the internal ddInfo.
    
    Parameters:
    
    ddInfo - the new DTS discovery info
  - setNodeName
```
public void setNodeName(javax.xml.namespace.QName nodeName)
```
    Sets a new nodeName to this XMLDocumentURI.
    
    Parameters:
    
    nodeName - the new node name
  - setRootNode
```
public void setRootNode(XBRLDocumentRootNode instance)
```
    Sets the root node.
    
    Parameters:
    
    instance - the new root node
  - evaluateList
```
public net.sf.saxon.s9api.XdmValue evaluateList(java.lang.String string)
```
    Evaluate list.
    
    Parameters:
    
    string - the string
    
    Returns:
    
    the xdm value
  - getXPathToRoot
```
public java.lang.String getXPathToRoot()
```
    Returns an XPath 2.0 expression to locate this document's node starting at this document's root This function updates the local namespace context if nodes in the path requires new namespaces to be declared.
    
    Returns:
    
    String
  - setContainer
```
public void setContainer(DTSContainer newContainer)
```
    Changes the dts container of this .
    
    Parameters:
    
    newContainer - the new container

Class XMLDocumentURI

Nested Class Summary

Nested classes/interfaces inherited from interface com.ihr.xbrl.om.XBRLValidation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XMLDocumentURI

XMLDocumentURI

XMLDocumentURI

Method Detail

getContainer

clear

getLocalFile

getPackageName

getPackageVersion

hashCode

equals

getPrefix

getPrefixes

setURI

getDocumentRootNode

getDocument

getOldDocument

getDocumentURI

getDocumentURICode

setDocumentURICode

getBase

getFriendlyName

getChildren

addChild

delChild

discoverDTS

getDTSKey

setDTSKey

isInDTS

getValidationReport

validate

invalidate

invalidate

isOnValidation

getDTSDiscoveryInfo

setXBRLDocumentInfo

getXBRLDocumentInfo

setDTSDiscoveryInfo

setNodeName

setRootNode

evaluateList

getXPathToRoot

setContainer