Cube

Method Summary
boolean	cancelDrop() Cancels deletion of the cube. Requires edit lock.
	cascadeDelete(String cellId) Deletes the specified cell and all its descendants. The cell is deleted immediately. All descendants are deleted in a background thread that may take hours, days, or weeks.
Cell	createCell(String name, String slice) Creates a cell with no metadata but does not persist it. Call cell.save() to persist.
Cell	createCell(String name, String slice, Data meta) Creates a cell but does not persist it. Call cell.save() to persist. Serialized metadata size cannot exceed 255 in length. See Data.toJSON().
	deleteCell(String cellId) Deletes the specified cell and its slices and data if any.
	deleteCells(String[] ids) Deletes the specified cells and its slices and data if any.
boolean	drop(Date date) Deletes this cube and all of its data on the specified date/time. Cell deletion is performed by a background thread and may not happen at the exact date/time specified or all at once. Once flagged for delete, cubes are locked for inserts and updates. Requires an edit lock. If the date is now or in the past, this cube will be immediately removed from the pal and no longer accessible.
boolean	editLock() Returns true if this thread successfully obtains an edit lock for doing cube modifications.
boolean	expand(int size) Returns true if the cube is successfully expanded by the specified size. Requires an edit lock.
Cell	getCell(String cellId) Gets the cell with the specified id.
Data	getCubeStats() Returns the approximate statistics of the cube.
String	getName() Returns the name of this cube.
double	getPercentUsed() Returns what percentage of this cube is used. When this reaches 100, the cube will be read-only/locked unless expanded.
Slice	getSlice(String slice) Returns a slice with the specified name from the primary slices.
Slice	getSlice(String slice, String value) Returns a slice with the specified name and value from the secondary slices.
PacketDataList	getSlices(long offset, int recordCount) Returns the slices for this cube.
String	getStorageProvider() Returns the name of the storage provider associated with this cube, if any.
boolean	isDropped() Returns true if the cube has been dropped.
boolean	isExpandable(int size) Returns true if the cube can be expanded by the specified size
boolean	isPublicImage() Returns true if files in cells can be served as images using the c:image tag
boolean	isSizeLocked() Returns true if the cube has reached its size limit and is locked. Once size locked, the cube can only be used for read and deletes.
	readMode() Sets this cube in readMode which allows read and deletes. This releases write locks and flushes stats if this thread had a write lock on the cube.
boolean	setPublicImage(boolean allowPublic) Sets whether or not imaged based files can be served with the c:image tag. Requires an edit lock.
boolean	setStorageProvider(String name) Sets the name of the storage provider associated with this cube. Returns false if there is an existing provider. Requires an edit lock.
boolean	setSystemStorageProvider(boolean override) If the enterprise has a system provider assigned, this will set the storage provider to the system. If the cube already has a storage provider assigned, this is ignored unless override is set to true. Returns false if there are existing remote files attached to an existing provider for this cube. Requires an edit lock.
String	toString() Returns a description of this object.
boolean	writeMode() Sets this cube in writeMode which allows inserts and updates. If the cube is dropped, this always returns false. If the cube is locked due to size limitation this will also return false. You can always read and delete, even from a locked or dropped cube.

Method Detail

---

boolean cancelDrop()

Cancels deletion of the cube. Requires edit lock.

Returns:  boolean

Since: 08-13-2019

---

cascadeDelete(String cellId)

Deletes the specified cell and all its descendants. The cell is deleted immediately. All descendants are deleted in a background thread that may take hours, days, or weeks.

Parameters:

• String   cellId Required parameter.

Since: 09-06-2019

---

Cell createCell(String name, String slice)

Creates a cell with no metadata but does not persist it. Call cell.save() to persist.

Parameters:

• String   name Required parameter. Maximum allowed size of parameter: 60
• String   slice Required parameter. Maximum allowed size of parameter: 120

Returns:  Cell

Since: 07-25-2019

---

Cell createCell(String name, String slice, Data meta)

Creates a cell but does not persist it. Call cell.save() to persist. Serialized metadata size cannot exceed 255 in length. See Data.toJSON().

Parameters:

• String   name Required parameter. Maximum allowed size of parameter: 60
• String   slice Required parameter. Maximum allowed size of parameter: 120
• Data   meta Required parameter.

Returns:  Cell

Since: 07-25-2019

---

deleteCell(String cellId)

Deletes the specified cell and its slices and data if any.

Parameters:

• String   cellId Required parameter.

Since: 07-25-2019

---

deleteCells(String[] ids)

Deletes the specified cells and its slices and data if any.

Parameters:

• String[]   ids Required parameter.

Since: 09-06-2019

---

boolean drop(Date date)

Deletes this cube and all of its data on the specified date/time. Cell deletion is performed by a background thread and may not happen at the exact date/time specified or all at once. Once flagged for delete, cubes are locked for inserts and updates. Requires an edit lock. If the date is now or in the past, this cube will be immediately removed from the pal and no longer accessible.

Parameters:

• Date   date Required parameter.

Returns:  boolean

Since: 08-13-2019

---

boolean editLock()

Returns true if this thread successfully obtains an edit lock for doing cube modifications.

Returns:  boolean

Since: 08-13-2019

---

boolean expand(int size)

Returns true if the cube is successfully expanded by the specified size. Requires an edit lock.

Parameters:

• int   size  - size in MB. Required parameter. Maximum allowed size of parameter: 1024

Returns:  boolean

Since: 08-13-2019

---

Cell getCell(String cellId)

Gets the cell with the specified id.

Parameters:

• String   cellId Required parameter.

Returns:  Cell

Since: 07-25-2019

---

Data getCubeStats()

Returns the approximate statistics of the cube.

Returns:  Data

Since: 08-13-2019

---

String getName()

Returns the name of this cube.

Returns:  String

Since: 08-12-2019

---

double getPercentUsed()

Returns what percentage of this cube is used. When this reaches 100, the cube will be read-only/locked unless expanded.

Returns:  double

Since: 08-13-2019

---

Slice getSlice(String slice)

Returns a slice with the specified name from the primary slices.

Parameters:

• String   slice Required parameter.

Returns:  Slice

Since: 07-25-2019

---

Slice getSlice(String slice, String value)

Returns a slice with the specified name and value from the secondary slices.

Parameters:

• String   slice Required parameter.
• String   value Required parameter.

Returns:  Slice

Since: 07-25-2019

---

PacketDataList getSlices(long offset, int recordCount)

Returns the slices for this cube.

Parameters:

• long   offset  - 0 based. Required parameter.
• int   recordCount Required parameter. Maximum allowed size of parameter: 1000

Returns:  PacketDataList

DataList Name: slices
DataList Fields: slice

Since: 05-12-2020

---

String getStorageProvider()

Returns the name of the storage provider associated with this cube, if any.

Returns:  String

Since: 07-25-2019

---

boolean isDropped()

Returns true if the cube has been dropped.

Returns:  boolean

Since: 08-13-2019

---

boolean isExpandable(int size)

Returns true if the cube can be expanded by the specified size

Parameters:

• int   size  - size in MB. Required parameter. Maximum allowed size of parameter: 1024

Returns:  boolean

Since: 08-13-2019

---

boolean isPublicImage()

Returns true if files in cells can be served as images using the c:image tag

Returns:  boolean

Since: 08-07-2019

---

boolean isSizeLocked()

Returns true if the cube has reached its size limit and is locked. Once size locked, the cube can only be used for read and deletes.

Returns:  boolean

Since: 08-13-2019

---

readMode()

Sets this cube in readMode which allows read and deletes. This releases write locks and flushes stats if this thread had a write lock on the cube.

Since: 08-13-2019

---

boolean setPublicImage(boolean allowPublic)

Sets whether or not imaged based files can be served with the c:image tag. Requires an edit lock.

Parameters:

• boolean   allowPublic Required parameter.

Returns:  boolean

Since: 08-07-2019

---

boolean setStorageProvider(String name)

Sets the name of the storage provider associated with this cube. Returns false if there is an existing provider. Requires an edit lock.

Parameters:

• String   name Required parameter.

Returns:  boolean

Since: 07-25-2019

---

boolean setSystemStorageProvider(boolean override)

If the enterprise has a system provider assigned, this will set the storage provider to the system. If the cube already has a storage provider assigned, this is ignored unless override is set to true. Returns false if there are existing remote files attached to an existing provider for this cube. Requires an edit lock.

Parameters:

• boolean   override Required parameter.

Returns:  boolean

Since: 04-20-2020

---

String toString()

Returns a description of this object.

Returns:  String

Since: 07-25-2019

---

boolean writeMode()

Sets this cube in writeMode which allows inserts and updates. If the cube is dropped, this always returns false. If the cube is locked due to size limitation this will also return false. You can always read and delete, even from a locked or dropped cube.

Returns:  boolean

Since: 08-13-2019