Hierarchy.Level (Open Foris Collect Server module 3.26.18 API)

java.lang.Object
- org.openforis.collect.mondrian.Hierarchy.Level

Enclosing class:: Hierarchy

public static class Hierarchy.Level
extends Object

Java class for anonymous complex type.

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

 <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>

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Hierarchy.Level.Closure` Java class for anonymous complex type.
`static class`	`Hierarchy.Level.Property` Java class for anonymous complex type.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Annotations`	`annotations`
`protected BigInteger`	`approxRowCount`
`protected String`	`caption`
`protected String`	`captionColumn`
`protected ExpressionView`	`captionExpression`
`protected Hierarchy.Level.Closure`	`closure`
`protected String`	`column`
`protected String`	`description`
`protected String`	`formatter`
`protected String`	`hideMemberIf`
`protected ExpressionView`	`keyExpression`
`protected String`	`levelType`
`protected String`	`name`
`protected String`	`nameColumn`
`protected ExpressionView`	`nameExpression`
`protected String`	`nullParentValue`
`protected String`	`ordinalColumn`
`protected ExpressionView`	`ordinalExpression`
`protected String`	`parentColumn`
`protected ExpressionView`	`parentExpression`
`protected List<Hierarchy.Level.Property>`	`property`
`protected String`	`table`
`protected String`	`type`
`protected Boolean`	`uniqueMembers`

Constructor Summary

Constructors
Constructor and Description

Level()

Constructors
Constructor and Description
`Level()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Annotations`	`getAnnotations()` Gets the value of the annotations property.
`BigInteger`	`getApproxRowCount()` Gets the value of the approxRowCount property.
`String`	`getCaption()` Gets the value of the caption property.
`String`	`getCaptionColumn()` Gets the value of the captionColumn property.
`ExpressionView`	`getCaptionExpression()` Gets the value of the captionExpression property.
`Hierarchy.Level.Closure`	`getClosure()` Gets the value of the closure property.
`String`	`getColumn()` Gets the value of the column property.
`String`	`getDescription()` Gets the value of the description property.
`String`	`getFormatter()` Gets the value of the formatter property.
`String`	`getHideMemberIf()` Gets the value of the hideMemberIf property.
`ExpressionView`	`getKeyExpression()` Gets the value of the keyExpression property.
`String`	`getLevelType()` Gets the value of the levelType property.
`String`	`getName()` Gets the value of the name property.
`String`	`getNameColumn()` Gets the value of the nameColumn property.
`ExpressionView`	`getNameExpression()` Gets the value of the nameExpression property.
`String`	`getNullParentValue()` Gets the value of the nullParentValue property.
`String`	`getOrdinalColumn()` Gets the value of the ordinalColumn property.
`ExpressionView`	`getOrdinalExpression()` Gets the value of the ordinalExpression property.
`String`	`getParentColumn()` Gets the value of the parentColumn property.
`ExpressionView`	`getParentExpression()` Gets the value of the parentExpression property.
`List<Hierarchy.Level.Property>`	`getProperty()` Gets the value of the property property.
`String`	`getTable()` Gets the value of the table property.
`String`	`getType()` Gets the value of the type property.
`boolean`	`isUniqueMembers()` Gets the value of the uniqueMembers property.
`void`	`setAnnotations(Annotations value)` Sets the value of the annotations property.
`void`	`setApproxRowCount(BigInteger value)` Sets the value of the approxRowCount property.
`void`	`setCaption(String value)` Sets the value of the caption property.
`void`	`setCaptionColumn(String value)` Sets the value of the captionColumn property.
`void`	`setCaptionExpression(ExpressionView value)` Sets the value of the captionExpression property.
`void`	`setClosure(Hierarchy.Level.Closure value)` Sets the value of the closure property.
`void`	`setColumn(String value)` Sets the value of the column property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setFormatter(String value)` Sets the value of the formatter property.
`void`	`setHideMemberIf(String value)` Sets the value of the hideMemberIf property.
`void`	`setKeyExpression(ExpressionView value)` Sets the value of the keyExpression property.
`void`	`setLevelType(String value)` Sets the value of the levelType property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setNameColumn(String value)` Sets the value of the nameColumn property.
`void`	`setNameExpression(ExpressionView value)` Sets the value of the nameExpression property.
`void`	`setNullParentValue(String value)` Sets the value of the nullParentValue property.
`void`	`setOrdinalColumn(String value)` Sets the value of the ordinalColumn property.
`void`	`setOrdinalExpression(ExpressionView value)` Sets the value of the ordinalExpression property.
`void`	`setParentColumn(String value)` Sets the value of the parentColumn property.
`void`	`setParentExpression(ExpressionView value)` Sets the value of the parentExpression property.
`void`	`setTable(String value)` Sets the value of the table property.
`void`	`setType(String value)` Sets the value of the type property.
`void`	`setUniqueMembers(Boolean value)` Sets the value of the uniqueMembers property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - annotations
```
protected Annotations annotations
```
  - keyExpression
```
protected ExpressionView keyExpression
```
  - nameExpression
```
protected ExpressionView nameExpression
```
  - captionExpression
```
protected ExpressionView captionExpression
```
  - ordinalExpression
```
protected ExpressionView ordinalExpression
```
  - parentExpression
```
protected ExpressionView parentExpression
```
  - closure
```
protected Hierarchy.Level.Closure closure
```
  - property
```
protected List<Hierarchy.Level.Property> property
```
  - approxRowCount
```
protected BigInteger approxRowCount
```
  - name
```
protected String name
```
  - table
```
protected String table
```
  - column
```
protected String column
```
  - nameColumn
```
protected String nameColumn
```
  - ordinalColumn
```
protected String ordinalColumn
```
  - parentColumn
```
protected String parentColumn
```
  - nullParentValue
```
protected String nullParentValue
```
  - type
```
protected String type
```
  - uniqueMembers
```
protected Boolean uniqueMembers
```
  - levelType
```
protected String levelType
```
  - hideMemberIf
```
protected String hideMemberIf
```
  - formatter
```
protected String formatter
```
  - caption
```
protected String caption
```
  - description
```
protected String description
```
  - captionColumn
```
protected String captionColumn
```
- Constructor Detail
  - Level
```
public Level()
```
- Method Detail
  - 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
  - getKeyExpression
```
public ExpressionView getKeyExpression()
```
    Gets the value of the keyExpression property.
    
    Returns:
    
    possible object is ExpressionView
  - setKeyExpression
```
public void setKeyExpression(ExpressionView value)
```
    Sets the value of the keyExpression property.
    
    Parameters:
    
    value - allowed object is ExpressionView
  - getNameExpression
```
public ExpressionView getNameExpression()
```
    Gets the value of the nameExpression property.
    
    Returns:
    
    possible object is ExpressionView
  - setNameExpression
```
public void setNameExpression(ExpressionView value)
```
    Sets the value of the nameExpression property.
    
    Parameters:
    
    value - allowed object is ExpressionView
  - getCaptionExpression
```
public ExpressionView getCaptionExpression()
```
    Gets the value of the captionExpression property.
    
    Returns:
    
    possible object is ExpressionView
  - setCaptionExpression
```
public void setCaptionExpression(ExpressionView value)
```
    Sets the value of the captionExpression property.
    
    Parameters:
    
    value - allowed object is ExpressionView
  - getOrdinalExpression
```
public ExpressionView getOrdinalExpression()
```
    Gets the value of the ordinalExpression property.
    
    Returns:
    
    possible object is ExpressionView
  - setOrdinalExpression
```
public void setOrdinalExpression(ExpressionView value)
```
    Sets the value of the ordinalExpression property.
    
    Parameters:
    
    value - allowed object is ExpressionView
  - getParentExpression
```
public ExpressionView getParentExpression()
```
    Gets the value of the parentExpression property.
    
    Returns:
    
    possible object is ExpressionView
  - setParentExpression
```
public void setParentExpression(ExpressionView value)
```
    Sets the value of the parentExpression property.
    
    Parameters:
    
    value - allowed object is ExpressionView
  - getClosure
```
public Hierarchy.Level.Closure getClosure()
```
    Gets the value of the closure property.
    
    Returns:
    
    possible object is Hierarchy.Level.Closure
  - setClosure
```
public void setClosure(Hierarchy.Level.Closure value)
```
    Sets the value of the closure property.
    
    Parameters:
    
    value - allowed object is Hierarchy.Level.Closure
  - getProperty
```
public List<Hierarchy.Level.Property> getProperty()
```
    Gets the value of the property 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 property property.
    For example, to add a new item, do as follows:
```
    getProperty().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Hierarchy.Level.Property
  - getApproxRowCount
```
public BigInteger getApproxRowCount()
```
    Gets the value of the approxRowCount property.
    
    Returns:
    
    possible object is BigInteger
  - setApproxRowCount
```
public void setApproxRowCount(BigInteger value)
```
    Sets the value of the approxRowCount property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - 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
  - getTable
```
public String getTable()
```
    Gets the value of the table property.
    
    Returns:
    
    possible object is String
  - setTable
```
public void setTable(String value)
```
    Sets the value of the table property.
    
    Parameters:
    
    value - allowed object is String
  - getColumn
```
public String getColumn()
```
    Gets the value of the column property.
    
    Returns:
    
    possible object is String
  - setColumn
```
public void setColumn(String value)
```
    Sets the value of the column property.
    
    Parameters:
    
    value - allowed object is String
  - getNameColumn
```
public String getNameColumn()
```
    Gets the value of the nameColumn property.
    
    Returns:
    
    possible object is String
  - setNameColumn
```
public void setNameColumn(String value)
```
    Sets the value of the nameColumn property.
    
    Parameters:
    
    value - allowed object is String
  - getOrdinalColumn
```
public String getOrdinalColumn()
```
    Gets the value of the ordinalColumn property.
    
    Returns:
    
    possible object is String
  - setOrdinalColumn
```
public void setOrdinalColumn(String value)
```
    Sets the value of the ordinalColumn property.
    
    Parameters:
    
    value - allowed object is String
  - getParentColumn
```
public String getParentColumn()
```
    Gets the value of the parentColumn property.
    
    Returns:
    
    possible object is String
  - setParentColumn
```
public void setParentColumn(String value)
```
    Sets the value of the parentColumn property.
    
    Parameters:
    
    value - allowed object is String
  - getNullParentValue
```
public String getNullParentValue()
```
    Gets the value of the nullParentValue property.
    
    Returns:
    
    possible object is String
  - setNullParentValue
```
public void setNullParentValue(String value)
```
    Sets the value of the nullParentValue property.
    
    Parameters:
    
    value - allowed object is String
  - getType
```
public String getType()
```
    Gets the value of the type property.
    
    Returns:
    
    possible object is String
  - setType
```
public void setType(String value)
```
    Sets the value of the type property.
    
    Parameters:
    
    value - allowed object is String
  - isUniqueMembers
```
public boolean isUniqueMembers()
```
    Gets the value of the uniqueMembers property.
    
    Returns:
    
    possible object is Boolean
  - setUniqueMembers
```
public void setUniqueMembers(Boolean value)
```
    Sets the value of the uniqueMembers property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getLevelType
```
public String getLevelType()
```
    Gets the value of the levelType property.
    
    Returns:
    
    possible object is String
  - setLevelType
```
public void setLevelType(String value)
```
    Sets the value of the levelType property.
    
    Parameters:
    
    value - allowed object is String
  - getHideMemberIf
```
public String getHideMemberIf()
```
    Gets the value of the hideMemberIf property.
    
    Returns:
    
    possible object is String
  - setHideMemberIf
```
public void setHideMemberIf(String value)
```
    Sets the value of the hideMemberIf property.
    
    Parameters:
    
    value - allowed object is String
  - getFormatter
```
public String getFormatter()
```
    Gets the value of the formatter property.
    
    Returns:
    
    possible object is String
  - setFormatter
```
public void setFormatter(String value)
```
    Sets the value of the formatter 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
  - getCaptionColumn
```
public String getCaptionColumn()
```
    Gets the value of the captionColumn property.
    
    Returns:
    
    possible object is String
  - setCaptionColumn
```
public void setCaptionColumn(String value)
```
    Sets the value of the captionColumn property.
    
    Parameters:
    
    value - allowed object is String

Class Hierarchy.Level

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

annotations

keyExpression

nameExpression

captionExpression

ordinalExpression

parentExpression

closure

property

approxRowCount

name

table

column

nameColumn

ordinalColumn

parentColumn

nullParentValue

type

uniqueMembers

levelType

hideMemberIf

formatter

caption

description

captionColumn

Constructor Detail

Level

Method Detail

getAnnotations

setAnnotations

getKeyExpression

setKeyExpression

getNameExpression

setNameExpression

getCaptionExpression

setCaptionExpression

getOrdinalExpression

setOrdinalExpression

getParentExpression

setParentExpression

getClosure

setClosure

getProperty

getApproxRowCount

setApproxRowCount

getName

setName

getTable

setTable

getColumn

setColumn

getNameColumn

setNameColumn

getOrdinalColumn

setOrdinalColumn

getParentColumn

setParentColumn

getNullParentValue

setNullParentValue

getType

setType

isUniqueMembers

setUniqueMembers

getLevelType

setLevelType

getHideMemberIf

setHideMemberIf

getFormatter

setFormatter

getCaption

setCaption

getDescription

setDescription

getCaptionColumn