PrivateDimension (Open Foris Collect Server module 4.0.7 API)

java.lang.Object
- org.openforis.collect.mondrian.PrivateDimension

public class PrivateDimension
extends Object

Private dimensions in the cube. A Dimension is a collection of hierarchies. There are two kinds: a public dimension belongs to a Schema, and be used by several cubes; a private dimension belongs to a Cube. The foreignKey field is only applicable to private dimensions.

Java class for PrivateDimension complex type.

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

 <complexType name="PrivateDimension">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="Annotations" type="{}Annotations" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Hierarchy" type="{}Hierarchy" maxOccurs="unbounded"/>
       </sequence>
       <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="type" default="Standard">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="Standard"/>
             <enumeration value="TimeDimension"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="caption" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="description" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="foreignKey" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="highCardinality" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<Annotations>`	`annotations`
`protected String`	`caption`
`protected String`	`description`
`protected String`	`foreignKey`
`protected List<Hierarchy>`	`hierarchy`
`protected Boolean`	`highCardinality`
`protected String`	`name`
`protected String`	`type`

Constructor Summary

Constructors
Constructor and Description

PrivateDimension()

Constructors
Constructor and Description
`PrivateDimension()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<Annotations>`	`getAnnotations()` Gets the value of the annotations property.
`String`	`getCaption()` Gets the value of the caption property.
`String`	`getDescription()` Gets the value of the description property.
`String`	`getForeignKey()` Gets the value of the foreignKey property.
`List<Hierarchy>`	`getHierarchy()` Gets the value of the hierarchy property.
`String`	`getName()` Gets the value of the name property.
`String`	`getType()` Gets the value of the type property.
`boolean`	`isHighCardinality()` Gets the value of the highCardinality property.
`void`	`setCaption(String value)` Sets the value of the caption property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setForeignKey(String value)` Sets the value of the foreignKey property.
`void`	`setHighCardinality(Boolean value)` Sets the value of the highCardinality property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setType(String value)` Sets the value of the type property.

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

- Field Detail
  - annotations
```
protected List<Annotations> annotations
```
  - hierarchy
```
protected List<Hierarchy> hierarchy
```
  - name
```
protected String name
```
  - type
```
protected String type
```
  - caption
```
protected String caption
```
  - description
```
protected String description
```
  - foreignKey
```
protected String foreignKey
```
  - highCardinality
```
protected Boolean highCardinality
```
- Constructor Detail
  - PrivateDimension
```
public PrivateDimension()
```
- Method Detail
  - getAnnotations
```
public List<Annotations> getAnnotations()
```
    Gets the value of the annotations 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 annotations property.
    For example, to add a new item, do as follows:
```
    getAnnotations().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Annotations
  - getHierarchy
```
public List<Hierarchy> getHierarchy()
```
    Gets the value of the hierarchy 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 hierarchy property.
    For example, to add a new item, do as follows:
```
    getHierarchy().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Hierarchy
  - 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
  - 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
  - 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
  - getForeignKey
```
public String getForeignKey()
```
    Gets the value of the foreignKey property.
    
    Returns:
    
    possible object is String
  - setForeignKey
```
public void setForeignKey(String value)
```
    Sets the value of the foreignKey property.
    
    Parameters:
    
    value - allowed object is String
  - isHighCardinality
```
public boolean isHighCardinality()
```
    Gets the value of the highCardinality property.
    
    Returns:
    
    possible object is Boolean
  - setHighCardinality
```
public void setHighCardinality(Boolean value)
```
    Sets the value of the highCardinality property.
    
    Parameters:
    
    value - allowed object is Boolean

Class PrivateDimension

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

annotations

hierarchy

name

type

caption

description

foreignKey

highCardinality

Constructor Detail

PrivateDimension

Method Detail

getAnnotations

getHierarchy

getName

setName

getType

setType

getCaption

setCaption

getDescription

setDescription

getForeignKey

setForeignKey

isHighCardinality

setHighCardinality