com.ihr.xbrl.versioning
Class VlVersioningProcessor

java.lang.Object
  com.ihr.xbrl.versioning.VlVersioningProcessor

public class VlVersioningProcessor
extends java.lang.Object

This is the versioning processor instance.

A VersionigProcessor can load the content of a versioning report in XBRL format. Provides methods to access to the report content and allows editing the report.

The processor allows the creation of XBRL Versioning Reports by comparing two DTSContainer objects.

Author:

Ignacio

Nested Class Summary

static class

VlVersioningProcessor.ClsVersioningNamespace

Field Summary

static javax.xml.namespace.QName

versionLinkbaseLink

Constructor Summary

VlVersioningProcessor(java.lang.String versioningDTSUri, java.lang.String versioningConfSuiteSchema)
Creates an instance of the versioning processor.

VlVersioningProcessor(java.lang.String versioningDTSUri, java.lang.String versioningConfSuiteSchema, DTSContainer fromDTS, DTSContainer toDTS)
Creates an instance of the versioning processor.

VlVersioningProcessor(java.lang.String versioningDTSUri, java.lang.String versioningConfSuiteSchema, XBRLInstance vlDTS)
Creates an instance of the versioning processor.

Method Summary

void	addAction(Action ac)
void	addAssignment(Assignment as)
void	compare() Launch the comparison of the fromDTS and the toDTS
java.util.Collection<Action>	getActions()
java.util.Collection<Assignment>	getAssignments()
DTSComparator	getComparator()
java.lang.String	getVersioningDTSUri()
boolean	isAssignmentsUpdated()
boolean	isDocumented(Event ev) Returns true if the event is in at least one action in this report
void	loadLaunchFile(java.net.URI temporaryFileURI) Load a launch file
void	loadVersioningReport(XBRLInstance versioningReport) Second edition of this method.
void	removeAction(Action action)
void	removeAssignment(Assignment assignment)
void	reset()
void	resetAssignmentsUpdated()
void	saveLaunchFile(java.net.URI fNameUri) Write the content of the versioning report in a launch file This is a temporary method. the Raw XML launch file will be used only in the conformance suite
void	setEmail(java.lang.String text)
void	setOwner(java.lang.String text)
void	setResult(java.net.URI resultFile)
void	setVersioningTestCaseXSLTUri(java.lang.String text)
ConceptActivityReport	whatHappendedTo(javax.xml.namespace.QName conceptFrom)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

versionLinkbaseLink

public static final javax.xml.namespace.QName versionLinkbaseLink

Constructor Detail

VlVersioningProcessor

public VlVersioningProcessor(java.lang.String versioningDTSUri,
                             java.lang.String versioningConfSuiteSchema)
                      throws com.rs.lic.LicenseVerificationException

Creates an instance of the versioning processor.

Parameters:

versioningDTSUri - String relative uri to the versioning schema

versioningConfSuiteSchema - String relative uri to the conformance suite schema

Throws:

com.rs.lic.LicenseVerificationException

VlVersioningProcessor

public VlVersioningProcessor(java.lang.String versioningDTSUri,
                             java.lang.String versioningConfSuiteSchema,
                             DTSContainer fromDTS,
                             DTSContainer toDTS)
                      throws DTSDiscoveryException,
                             com.rs.lic.LicenseVerificationException

Creates an instance of the versioning processor.

Parameters:

versioningDTSUri - String relative uri to the versioning schema

versioningConfSuiteSchema - String relative uri to the conformance suite schema

fromDTS - DTSContainer the initial from DTS

toDTS - DTSContainer the initial to DTS

Throws:

DTSDiscoveryException

com.rs.lic.LicenseVerificationException

VlVersioningProcessor

public VlVersioningProcessor(java.lang.String versioningDTSUri,
                             java.lang.String versioningConfSuiteSchema,
                             XBRLInstance vlDTS)
                      throws DTSDiscoveryException,
                             com.rs.lic.LicenseVerificationException

Creates an instance of the versioning processor.

Parameters:

versioningDTSUri - String relative uri to the versioning schema

versioningConfSuiteSchema - String relative uri to the conformance suite schema

vlDTS - instance document according to the versioning taxonomy schema to load

Throws:

DTSDiscoveryException

com.rs.lic.LicenseVerificationException

Method Detail

setOwner

public void setOwner(java.lang.String text)

setResult

public void setResult(java.net.URI resultFile)

setEmail

public void setEmail(java.lang.String text)

setVersioningTestCaseXSLTUri

public void setVersioningTestCaseXSLTUri(java.lang.String text)

loadVersioningReport

public void loadVersioningReport(XBRLInstance versioningReport)
                          throws DTSDiscoveryException,
                                 com.rs.lic.LicenseVerificationException

Second edition of this method. This loads an instande document that is a versioning report. The instance is not validated against the XBRL 2.1 specification.

Parameters:

versioningReport - XBRLInstance

Throws:

DTSDiscoveryException

com.rs.lic.LicenseVerificationException - Occurs if the user does not have a license for any of the files in the DTS of the versioning report

saveLaunchFile

public void saveLaunchFile(java.net.URI fNameUri)
                    throws XBRLSerializationException

Write the content of the versioning report in a launch file This is a temporary method. the Raw XML launch file will be used only in the conformance suite

Parameters:

fNameUri - URI

Throws:

XBRLSerializationException

getVersioningDTSUri

public java.lang.String getVersioningDTSUri()

Returns:

String

loadLaunchFile

public void loadLaunchFile(java.net.URI temporaryFileURI)
                    throws DTSDiscoveryException

Load a launch file

Parameters:

temporaryFileURI -

Throws:

DTSDiscoveryException

java.io.IOException

reset

public void reset()

compare

public void compare()

Launch the comparison of the fromDTS and the toDTS

getComparator

public DTSComparator getComparator()

getActions

public java.util.Collection<Action> getActions()

getAssignments

public java.util.Collection<Assignment> getAssignments()

addAssignment

public void addAssignment(Assignment as)

Parameters:

as -

addAction

public void addAction(Action ac)

Parameters:

ac -

removeAssignment

public void removeAssignment(Assignment assignment)

Parameters:

assignment -

removeAction

public void removeAction(Action action)

Parameters:

action -

isAssignmentsUpdated

public boolean isAssignmentsUpdated()

resetAssignmentsUpdated

public void resetAssignmentsUpdated()

isDocumented

public boolean isDocumented(Event ev)

Returns true if the event is in at least one action in this report

Parameters:

ev -

Returns:

boolean

whatHappendedTo

public ConceptActivityReport whatHappendedTo(javax.xml.namespace.QName conceptFrom)

Parameters:

conceptFrom - QName

Returns:

ConceptActivityReport