'Business Report Engine
'Version .03
'How to document the code: http://tutorial.programming4.us/windows_7/Visual-Basic-2010---Documenting-the-Source-Code---Implementing-XML-Comments.aspx
'See General Business Reporting Application Profile: http://www.xbrlsite.com/2014/Library/GeneralBusinessReportingProfile-2013-11-30.pdf
'See NOLAP Application Profile: http://www.xbrlsite.com/2014/Library/NOLAP-2014-07-01.pdf



''' <summary>Representation of the entire business report</summary>
Public Class BusinessReport

    Public Facts As Collection
    Public Components As Collection
    Public ParentheticalExplainations As Collection
    Public BusinessRules As Collection

    Public ReportElements As Collection


    Private m_Facts As Collection

    ''' <summary>Loads a business report into working memory from the XML model format.</summary>
    ''' <remarks>This loads the representation format XML</remarks>
    Public Sub Load()

    End Sub

    ''' <summary>Loads a business report into working memory from the XBRL format.</summary>
    ''' <remarks>This loads the XBRL format, if the XML model format is not available</remarks>
    Public Sub LoadXBRL()

    End Sub


    ''' <summary>Saves a business report into XML model format for storage in local file system.</summary>
    ''' <remarks>This saves what is currently in memory to the local file system.</remarks>
    Public Sub Save()

    End Sub


    ''' <summary>Saves a business report into XML model format for storage to a web service which supports this format.</summary>
    ''' <remarks>This saves what is currently in memory to a web service API which supports this workflow.</remarks>
    Public Sub SaveToWebService()

    End Sub

    ''' <summary>Exports what is in memory to a serialization which complies with the XBRL technical syntax.</summary>
    ''' <remarks>This saves what is currently in memory to a web service API which supports this workflow.</remarks>
    Public Sub ExportXBRL()

    End Sub


    ''' <summary>Generates information which is then used to render the business report.</summary>
    ''' <remarks>This rendering information can be sent of a GUI control which specializes in rendering this format.</remarks>
    Public Sub Render()

    End Sub





    ''' <summary>Adds a fact to the business report</summary>
    ''' <remarks>Not sure if you want to allow a fact to be added to a business report; perhaps facts should ONLY be allowed to be added to a component</remarks>
    Public Sub AddFact()

    End Sub

    ''' <summary>Deletes fact from the business report</summary>
    Public Sub DeleteFact()

    End Sub

    ''' <summary>Adds a component to business report</summary>
    Public Sub AddComponent()

    End Sub

    ''' <summary>Deletes a component from the business report</summary>
    Public Sub DeleteComponent()

    End Sub

    ''' <summary>Adds a parenthetical explaination to the business report</summary>
    Public Sub AddParentheticalExplaination()

    End Sub

    ''' <summary>Deletes a parenthetical explaination from the business report</summary>
    Public Sub DeleteParentheticalExplaination()

    End Sub

    'Not sure if this is appropriate, most business rules are related to a component
    'However, some business rules are not related to a component

    ''' <summary>Adds a business rule to the business report</summary>
    Public Sub AddBusinessRule()

    End Sub

    ''' <summary>Deletes a business rule from the business report</summary>
    Public Sub DeleteBusinessRule()

    End Sub

    ''' <summary>Adds a report element to the business report</summary>
    ''' <remarks>Not sure I really want to do this; report elements always fit into a component (or should).  But maybe this would be good to add a report element which will eventually be added to a component.</remarks>
    Public Sub AddReportElement()

    End Sub


    ''' <summary>Deletes a report element from the business report</summary>
    Public Sub DeleteReportElement()

    End Sub


    ''' <summary>Validates the entire business report</summary>
    Public Sub Validate()

    End Sub
End Class

''' <summary>Class for a component of a business report</summary>
Public Class Component

    Public Network As String
    Public Table As String
    Public FactTable As Collection
    Public ModelStructure As Collection

    ''' <summary>Validates the individual component</summary>
    Public Sub Validate()

    End Sub

    ''' <summary>Generates information which is then used to render the component.</summary>
    ''' <remarks>This rendering information can be sent of a GUI control which specializes in rendering this format.</remarks>
    Public Sub Render()

    End Sub


End Class

''' <summary>Class for a fact which is contained within a component which is part of a business report</summary>
Public Class Fact

    Public Characteristics As Collection

    ''' <summary>A value, or fact value, could be NUMERIC or NONNUMERIC</summary>
    Public Value As VariantType
    Public Rounding As String
    Public Units As String
    Public ParantheticalExplainations As Collection

    ''' <summary>Adds a characteristic to the collection of characteristics of a fact</summary>
    Public Sub AddCharacteristic()

    End Sub


    ''' <summary>Deletes a characteristic from the collection of characteristics of a fact</summary>
    Public Sub DeleteCharacteristic()

    End Sub


    ''' <summary>Adds a parenthetical explaination to the collection of parenthetical explainations of a fact</summary>
    Public Sub AddParantheticalExplaination()

    End Sub

    ''' <summary>Deletes a parenthetical explaination from the collection of parenthetical explainations of a fact</summary>
    Public Sub DeleteParantheticalExplaination()

    End Sub

    ''' <summary>Updates or changes the value of a fact to a newly provided value</summary>
    Public Sub UpdateValue()

    End Sub

    ''' <summary>Updates or changes the rounding of a fact to a newly provided value</summary>
    ''' <remarks>Rounding is the same thing as 'decimals' in XBRL</remarks>
    Public Sub UpdateRouding()

    End Sub

    ''' <summary>Updates or changes the units of a fact to a newly provided value</summary>
    Public Sub UpdateUnits()

    End Sub

    ''' <summary>Validates the syntax and semantics of a fact</summary>
    Public Sub Validate()
        'Validates the fact
    End Sub

End Class


''' <summary>Class for a parenthetical explaination which is part of a fact contained within a business report</summary>
''' <remarks>The syntax of a parenthetical explaination is an XBRL footnote</remarks>
Public Class ParentheticalExplaination

    Public Identifier As String
    Public Category As String
    Public Value As String

    ''' <summary>Validates a parenthetical explaination</summary>
    Public Sub Validate()

    End Sub
End Class

''' <summary>Class for a characteristic which which is a part of a fact</summary>
''' <remarks>Other terms for characteristic are ASPECT or DIMENSION.  However, the ENTITY and PERIOD parts of a context are also characteristics.  ENTITY and PERIOD are defined as ASPECTS per the XBRL Abstract Model 2.0</remarks>
Public Class Characteristic

    Public Name As String
    Public Member As String

End Class

''' <summary>Class for a busiess rule</summary>
''' <remarks>Business rules can be part of a COMPONENT or they can be part of a BUSINESS REPORT.  For example Assets=LiabilitiesAndEquity is NOT part of COMPONENT rather it is associated with the BUSINESS REPORT</remarks>
Public Class BusinessRule

    Public Identifier As String
    Public Category As String
    Public Rule As String

    ''' <summary>Validates the business rule</summary>
    Public Sub Validate()

    End Sub

End Class


''' <summary>Allowed values for a ConceptArrangementPattern</summary>
''' <remarks>NOTE that business users MAY need to add additional concept arrangement patterns.  For more information see http://www.xbrlsite.com/DigitalFinancialReporting/Metapatterns/2013-05-15/ </remarks>
Enum ConceptArrangementPattern

    RollUp
    RollForward
    Adjustment
    Variance
    Hierarchy
    ComplexComputation

End Enum

''' <summary>Allowed values for a MemberArrangementPattern</summary>
''' <remarks>NOTE that business users MAY need to add additional member arrangement patterns. NOTE that this needs a lot of work. For more information see http://www.xbrlsite.com/DigitalFinancialReporting/MemberArrangementPatterns/2013-05-15/ and see http://financialreportontology.wikispaces.com/Relationship.</remarks>
Enum MemberArrangementPattern

    WholePart
    CollectionMember
    ObjectStuff

End Enum

''' <remarks>Unclear about this.  Could be redundant.</remarks>
Enum BusinessRuleCategory

    RollUp
    RollForward
    MemberAggregation
    Adjustment
    Variance

End Enum


''' <summary>Class for a ReportElement which is part of the model or representation structure of a business report</summary>
''' <remarks>Note that a business user never directly works with the notion of a report element.  Business users work with Networks, Tables, Axis, Member, LineItems, Abstract or Concept. Every report element fits into one of those seven categories</remarks>
Public Class ReportElement

    ''' <summary>Uniquely identifies the report element</summary>
    ''' <remarks>Every report element requires an identifier. The identifier is automatically managed by the application and is read only.</remarks>
    Private Identifier As String

    ''' <summary>Name the report element</summary>
    ''' <remarks>Every report element requires an name. NOTE that the name of a Network is equivalent to the URI of the Network</remarks>
    Public Name As String

    ''' <summary>Standard label of a report element</summary>
    ''' <remarks>Every report element requires a label.  The standard label is also part of the label collection. The Network definition is equivalent to the label.</remarks>
    Public StandardLabel As String

    ''' <summary>Documentation or definition of a report element</summary>
    ''' <remarks>Every report element requires documentation.  The documentation is also part of the label collection.</remarks>
    Public Documentation As String

    ''' <summary>Report element class or object type or category.</summary>
    ''' <remarks>Every report element is either a: Network, Table, Axis, Member, LineItems, Abstract, Concept.</remarks>
    Public ReportElementClass As String



    ''' <summary>Adds a label to a report element</summary>
    Public Sub AddLabel()

    End Sub

    ''' <summary>Deletes a label from a report element</summary>
    Public Sub DeleteLabel()

    End Sub

    ''' <summary>Validates a report element.</summary>
    Public Sub Validate()
        'Validates the report element
    End Sub

End Class

''' <summary>Allowed values for ReportElementClass</summary>
''' <remarks>This might not be totally correct, but I think it is.  LineItems is really a characteristic.  All Axis are characteristics.  Entity and Period, which are NOT in the model are also characteristics.</remarks>
Enum ReportElementClasses

    ''' <summary>A network is a set of report elements.</summary>
    ''' <remarks>A network is the resolved base set of extended links within an XBRL terms. A Network has a NAME and a LABEL which are equivalent to the Network URI and Definition respectively.</remarks>
    Network

    ''' <summary>A TABLE is the same thing as an XBRL Dimensions Hypercube.  Other terms used to describe this are matrix, cube, array.</summary>
    ''' <remarks>A Table has only a NAME and LABEL.  The type attrubite is always set to "string", the periodType is always set to "duration", and abstract is always TRUE.</remarks>
    Table           'Hypercube

    ''' <summary>An AXIS is the same thing as an XBRL Dimensions Dimension.  Other terms used to describe this are aspect and characteristic.</summary>
    ''' <remarks>A AXIS has only a NAME and LABEL.  The type attrubite is always set to "nonnum:domainItemType", the periodType is always set to "duration", and abstract is always TRUE.</remarks>
    Axis            'Dimension, Aspect, Characteristic

    ''' <summary>An MEMBER is the same thing as an XBRL Dimensions member.</summary>
    ''' <remarks>A MEMBER has only a NAME and LABEL.  The type attrubite is always set to "string", the periodType is always set to "duration", and abstract is always TRUE.</remarks>
    Member

    ''' <summary>A LineItems is the same thing as an XBRL Dimensions Primary Item.</summary>
    ''' <remarks>A LINEITEMS has only a NAME and LABEL.  The type attrubite is always set to "string", the periodType is always set to "duration", and abstract is always TRUE.</remarks>
    LineItems       'Primary items

    ''' <summary>An CONCEPT is the same thing as an XBRL Dimensions Primary Item which has an abstract attribute value equal to FALSE.</summary>
    ''' <remarks>A CONCEPT has a NAME, LABEL, DataType, PeriodType, and an optional BALANCE property.  The type attrubite is always set to "string", the periodType is always set to "duration", and abstract is always TRUE.</remarks>
    Concept

    ''' <summary>An ABSTRACT is the same thing as an XBRL Dimensions Primary Item which has an abstract attribute value equal to TRUE.</summary>
    ''' <remarks>A LINEITEMS has only a NAME and LABEL.  The type attrubite is always set to "string", the periodType is always set to "duration", and abstract is always TRUE.</remarks>
    Abstract

End Enum

''' <summary>Equivalent to XBRL Network</summary>
Public Class Network
    Inherits ReportElement
End Class

''' <summary>Equivalent to XBRL Dimensions hypercube</summary>
''' <remarks>NOTE that in this model, EVERY report element exists with a Table.  That Table may be explicily defined or implied.</remarks>
Public Class Table                         'This is a HYPERCUBE
    Inherits ReportElement
End Class

''' <summary>Equivalent to XBRL Dimensions dimension</summary>
Public Class Axis
    Inherits ReportElement
End Class

''' <summary>Equivalent to XBRL Dimensions member</summary>
''' <remarks>NOTE that many times the root member is erroneously referred to as a DOMAIN.  This is incorrect.  A root member is a member.  A domain is the set all members of an Axis.</remarks>
Public Class Member
    Inherits ReportElement
End Class

''' <summary>Equivalent to XBRL Dimensions set of primary items</summary>
Public Class LineItems
    Inherits ReportElement
End Class

''' <summary>Equivalent to XBRL Dimensions primary item</summary>
Public Class Concept

    Inherits ReportElement

    Public DataType As String
    Public BalanceType As String
    Public PeriodType As String

End Class

''' <summary>Equivalent to XBRL Network</summary>
Public Class Abstract
    Inherits ReportElement
End Class


''' <summary>Equivalent to XBRL Network</summary>
Public Class Label

    Public Name As String
    Public LabelRole As String
    Public Value As String


End Class

''' <summary>The RepresentationStructure provides the relations between the report elements which make up the structure of a component of a business report</summary>
''' <remarks>The representation structure, or also called model structure, is NOT the same thing as XBRL presentation relations.  A representation structure is a composite of the XBRL presentation, XBRL calculation, XBRL definition relations into ONE set of relations which can then be used to autogenerate the XBRL presentation, calculation, and definition relations.</remarks>
Public Class RepresentationStructure

    Public FromReportElement As String
    Public ToReportElement As String
    Public RelationType As String
    Public Order As Integer
    Public NegateValue As String

    Public ReportElements As Collection

    ''' <summary>Validates the representation structure.</summary>
    Public Sub Validate()

    End Sub

End Class


''' <summary>The PresentationStructure is optional and provides the XBRL presentation relations should a business user choose to manage those relations manually, rather than allow the application to manage the relations</summary>
''' <remarks>The PresentationStructure is totally optional.  It is only used when a business user chooses to have more control over how XBRL presentation relations are articulated.</remarks>
Public Class PresentationStructure

    Public FromReportElement As String
    Public ToReportElement As String
    Public RelationType As String
    Public PreferredLabel As String

    Public Order As Integer

    Public reportReportElementselements As Collection

    ''' <summary>Validates the presentation structure</summary>
    Public Sub Validate()
        'Validates the presentation structure
    End Sub

End Class