Package org.openforis.collect.mondrian

Class Hierarchy

java.lang.Object
org.openforis.collect.mondrian.Hierarchy
public class Hierarchy extends Object
Defines a hierarchy. You must specify at most one or memberReaderClass. If you specify none, the hierarchy is assumed to come from the same fact table of the current cube.

Java class for Hierarchy complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="Hierarchy">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="Annotations" type="{}Annotations" minOccurs="0"/>
         <group ref="{}Relation" minOccurs="0"/>
         <element name="Level" maxOccurs="unbounded">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <sequence>
                   <element name="Annotations" type="{}Annotations" minOccurs="0"/>
                   <element name="KeyExpression" type="{}ExpressionView" minOccurs="0"/>
                   <element name="NameExpression" type="{}ExpressionView" minOccurs="0"/>
                   <element name="CaptionExpression" type="{}ExpressionView" minOccurs="0"/>
                   <element name="OrdinalExpression" type="{}ExpressionView" minOccurs="0"/>
                   <element name="ParentExpression" type="{}ExpressionView" minOccurs="0"/>
                   <element name="Closure" minOccurs="0">
                     <complexType>
                       <complexContent>
                         <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                           <sequence>
                             <element name="Table" type="{}Table"/>
                           </sequence>
                           <attribute name="parentColumn" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
                           <attribute name="childColumn" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
                         </restriction>
                       </complexContent>
                     </complexType>
                   </element>
                   <element name="Property" maxOccurs="unbounded" minOccurs="0">
                     <complexType>
                       <complexContent>
                         <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                           <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
                           <attribute name="column" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
                           <attribute name="type" default="String">
                             <simpleType>
                               <restriction base="{http://www.w3.org/2001/XMLSchema}string">
                                 <enumeration value="String"/>
                                 <enumeration value="Numeric"/>
                                 <enumeration value="Integer"/>
                                 <enumeration value="Boolean"/>
                                 <enumeration value="Date"/>
                                 <enumeration value="Time"/>
                                 <enumeration value="Timestamp"/>
                               </restriction>
                             </simpleType>
                           </attribute>
                           <attribute name="formatter" type="{http://www.w3.org/2001/XMLSchema}string" />
                           <attribute name="caption" type="{http://www.w3.org/2001/XMLSchema}string" />
                           <attribute name="description" type="{http://www.w3.org/2001/XMLSchema}string" />
                           <attribute name="dependsOnLevelValue" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
                         </restriction>
                       </complexContent>
                     </complexType>
                   </element>
                 </sequence>
                 <attribute name="approxRowCount" type="{http://www.w3.org/2001/XMLSchema}integer" />
                 <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
                 <attribute name="table" type="{http://www.w3.org/2001/XMLSchema}string" />
                 <attribute name="column" type="{http://www.w3.org/2001/XMLSchema}string" />
                 <attribute name="nameColumn" type="{http://www.w3.org/2001/XMLSchema}string" />
                 <attribute name="ordinalColumn" type="{http://www.w3.org/2001/XMLSchema}string" />
                 <attribute name="parentColumn" type="{http://www.w3.org/2001/XMLSchema}string" />
                 <attribute name="nullParentValue" type="{http://www.w3.org/2001/XMLSchema}string" />
                 <attribute name="type">
                   <simpleType>
                     <restriction base="{http://www.w3.org/2001/XMLSchema}string">
                       <enumeration value="String"/>
                       <enumeration value="Numeric"/>
                       <enumeration value="Integer"/>
                       <enumeration value="Boolean"/>
                       <enumeration value="Date"/>
                       <enumeration value="Time"/>
                       <enumeration value="Timestamp"/>
                     </restriction>
                   </simpleType>
                 </attribute>
                 <attribute name="uniqueMembers" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
                 <attribute name="levelType" default="Regular">
                   <simpleType>
                     <restriction base="{http://www.w3.org/2001/XMLSchema}string">
                       <enumeration value="Regular"/>
                       <enumeration value="TimeYears"/>
                       <enumeration value="TimeQuarters"/>
                       <enumeration value="TimeMonths"/>
                       <enumeration value="TimeWeeks"/>
                       <enumeration value="TimeDays"/>
                     </restriction>
                   </simpleType>
                 </attribute>
                 <attribute name="hideMemberIf" default="Never">
                   <simpleType>
                     <restriction base="{http://www.w3.org/2001/XMLSchema}string">
                       <enumeration value="Never"/>
                       <enumeration value="IfBlankName"/>
                       <enumeration value="IfParentsName"/>
                     </restriction>
                   </simpleType>
                 </attribute>
                 <attribute name="formatter" type="{http://www.w3.org/2001/XMLSchema}string" />
                 <attribute name="caption" type="{http://www.w3.org/2001/XMLSchema}string" />
                 <attribute name="description" type="{http://www.w3.org/2001/XMLSchema}string" />
                 <attribute name="captionColumn" type="{http://www.w3.org/2001/XMLSchema}string" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="MemberReaderParameter" maxOccurs="unbounded" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
                 <attribute name="value" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
       </sequence>
       <attribute name="name" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="hasAll" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="allMemberName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="allMemberCaption" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="allLevelName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="primaryKey" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="primaryKeyTable" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="defaultMember" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="memberReaderClass" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="caption" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="description" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="uniqueKeyLevelName" type="{http://www.w3.org/2001/XMLSchema}string" />
     </restriction>
   </complexContent>
 </complexType>

  • Field Details

    • annotations

      protected Annotations annotations

    • table

      protected Table table

    • view

      protected View view

    • join

      protected Hierarchy.Join join

    • inlineTable

      protected Hierarchy.InlineTable inlineTable

    • level

      protected List<Hierarchy.Level> level

    • memberReaderParameter

      protected List<Hierarchy.MemberReaderParameter> memberReaderParameter

    • name

      protected String name

    • hasAll

      protected boolean hasAll

    • allMemberName

      protected String allMemberName

    • allMemberCaption

      protected String allMemberCaption

    • allLevelName

      protected String allLevelName

    • primaryKey

      protected String primaryKey

    • primaryKeyTable

      protected String primaryKeyTable

    • defaultMember

      protected String defaultMember

    • memberReaderClass

      protected String memberReaderClass

    • caption

      protected String caption

    • description

      protected String description

    • uniqueKeyLevelName

      protected String uniqueKeyLevelName

  • Constructor Details

    • Hierarchy

      public Hierarchy()

  • Method Details

    • getAnnotations

      public Annotations getAnnotations()
      Gets the value of the annotations property.
      Returns:
      possible object is Annotations

    • setAnnotations

      public void setAnnotations(Annotations value)
      Sets the value of the annotations property.
      Parameters:
      value - allowed object is Annotations

    • getTable

      public Table getTable()
      Gets the value of the table property.
      Returns:
      possible object is Table

    • setTable

      public void setTable(Table value)
      Sets the value of the table property.
      Parameters:
      value - allowed object is Table

    • getView

      public View getView()
      Gets the value of the view property.
      Returns:
      possible object is View

    • setView

      public void setView(View value)
      Sets the value of the view property.
      Parameters:
      value - allowed object is View

    • getJoin

      public Hierarchy.Join getJoin()
      Gets the value of the join property.
      Returns:
      possible object is Hierarchy.Join

    • setJoin

      public void setJoin(Hierarchy.Join value)
      Sets the value of the join property.
      Parameters:
      value - allowed object is Hierarchy.Join

    • getInlineTable

      public Hierarchy.InlineTable getInlineTable()
      Gets the value of the inlineTable property.
      Returns:
      possible object is Hierarchy.InlineTable

    • setInlineTable

      public void setInlineTable(Hierarchy.InlineTable value)
      Sets the value of the inlineTable property.
      Parameters:
      value - allowed object is Hierarchy.InlineTable

    • getLevel

      public List<Hierarchy.Level> getLevel()
      Gets the value of the level property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the level property.

      For example, to add a new item, do as follows: 

          getLevel().add(newItem);

      Objects of the following type(s) are allowed in the list Hierarchy.Level

    • getMemberReaderParameter

      public List<Hierarchy.MemberReaderParameter> getMemberReaderParameter()
      Gets the value of the memberReaderParameter property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the memberReaderParameter property.

      For example, to add a new item, do as follows: 

          getMemberReaderParameter().add(newItem);

      Objects of the following type(s) are allowed in the list Hierarchy.MemberReaderParameter

    • getName

      public String getName()
      Gets the value of the name property.
      Returns:
      possible object is String

    • setName

      public void setName(String value)
      Sets the value of the name property.
      Parameters:
      value - allowed object is String

    • isHasAll

      public boolean isHasAll()
      Gets the value of the hasAll property.

    • setHasAll

      public void setHasAll(boolean value)
      Sets the value of the hasAll property.

    • getAllMemberName

      public String getAllMemberName()
      Gets the value of the allMemberName property.
      Returns:
      possible object is String

    • setAllMemberName

      public void setAllMemberName(String value)
      Sets the value of the allMemberName property.
      Parameters:
      value - allowed object is String

    • getAllMemberCaption

      public String getAllMemberCaption()
      Gets the value of the allMemberCaption property.
      Returns:
      possible object is String

    • setAllMemberCaption

      public void setAllMemberCaption(String value)
      Sets the value of the allMemberCaption property.
      Parameters:
      value - allowed object is String

    • getAllLevelName

      public String getAllLevelName()
      Gets the value of the allLevelName property.
      Returns:
      possible object is String

    • setAllLevelName

      public void setAllLevelName(String value)
      Sets the value of the allLevelName property.
      Parameters:
      value - allowed object is String

    • getPrimaryKey

      public String getPrimaryKey()
      Gets the value of the primaryKey property.
      Returns:
      possible object is String

    • setPrimaryKey

      public void setPrimaryKey(String value)
      Sets the value of the primaryKey property.
      Parameters:
      value - allowed object is String

    • getPrimaryKeyTable

      public String getPrimaryKeyTable()
      Gets the value of the primaryKeyTable property.
      Returns:
      possible object is String

    • setPrimaryKeyTable

      public void setPrimaryKeyTable(String value)
      Sets the value of the primaryKeyTable property.
      Parameters:
      value - allowed object is String

    • getDefaultMember

      public String getDefaultMember()
      Gets the value of the defaultMember property.
      Returns:
      possible object is String

    • setDefaultMember

      public void setDefaultMember(String value)
      Sets the value of the defaultMember property.
      Parameters:
      value - allowed object is String

    • getMemberReaderClass

      public String getMemberReaderClass()
      Gets the value of the memberReaderClass property.
      Returns:
      possible object is String

    • setMemberReaderClass

      public void setMemberReaderClass(String value)
      Sets the value of the memberReaderClass property.
      Parameters:
      value - allowed object is String

    • getCaption

      public String getCaption()
      Gets the value of the caption property.
      Returns:
      possible object is String

    • setCaption

      public void setCaption(String value)
      Sets the value of the caption property.
      Parameters:
      value - allowed object is String

    • getDescription

      public String getDescription()
      Gets the value of the description property.
      Returns:
      possible object is String

    • setDescription

      public void setDescription(String value)
      Sets the value of the description property.
      Parameters:
      value - allowed object is String

    • getUniqueKeyLevelName

      public String getUniqueKeyLevelName()
      Gets the value of the uniqueKeyLevelName property.
      Returns:
      possible object is String

    • setUniqueKeyLevelName

      public void setUniqueKeyLevelName(String value)
      Sets the value of the uniqueKeyLevelName property.
      Parameters:
      value - allowed object is String