Column (Groovy Documentation)

com.cedarsoftware.ncube.Column

All Implemented Interfaces and Traits:

java.lang.Comparable
```
@groovy.transform.CompileStatic
class Column
extends java.lang.Object
```
Holds the value of a 'column' on an axis. This class exists in order to allow additional columns to be inserted onto an axis, without having to "move" the existing cells. Furthermore, for some axis types (String), it is often better for display purposes to use the display order, as opposed to it's sort order (e.g., months-of-year, days-of-week) for display.
Authors:
John DeRegnaucourt ([email protected])
Copyright (c) Cedar Software LLC

Licensed under the Apache License, Version 2.0 (the "License") you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`DEFAULT_VALUE`
`static java.lang.String`	`NAME`

Constructor Summary

Constructors
Constructor and description
`Column (java.lang.Comparable value, long id = 0L, java.util.Map metaProps = null, int order = -1)`
`Column (Column source)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addMetaProperties(java.util.Map<java.lang.String, java.lang.Object> allAtOnce)` Add a Map of meta properties all at once.
	`void`	`clearMetaProperties()` Remove all meta properties associated to this Column.
	`int`	`compareTo(java.lang.Comparable that)`
	`boolean`	`equals(java.lang.Object that)`
	`java.lang.String`	`getColumnName()` Get the optional name of a column.
	`int`	`getDisplayOrder()`
	`long`	`getId()` Returns: long ID of this column.
	`java.util.Map<java.lang.String, java.lang.Object>`	`getMetaProperties()` @return Map (case insensitive keys) containing meta (additional) properties for the n-cube.
	`java.lang.Object`	`getMetaProperty(java.lang.String key)` Fetch the value associated to the passed in Key from the MetaProperties (if any exist).
	`java.lang.Comparable`	`getValue()` @return Comparable value of the column.
	`java.lang.Comparable`	`getValueThatMatches()` Returns: a value that will match this column.
	`int`	`hashCode()`
	`boolean`	`isDefault()` Returns: boolean true if this is the Default column, false otherwise.
	`java.lang.Object`	`removeMetaProperty(java.lang.String key)` Remove a meta-property entry
	`void`	`setColumnName(java.lang.String name)` Set the optional name of a column.
	`java.lang.Object`	`setMetaProperty(java.lang.String key, java.lang.Object metaPropValue)` Set (add / overwrite) a Meta Property associated to this Column.
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - public static final java.lang.String DEFAULT_VALUE
  - public static final java.lang.String NAME
- Constructor Detail
  - Column(java.lang.Comparable value, long id = 0L, java.util.Map metaProps = null, int order = -1)
  - Column(Column source)
- Method Detail
  - void addMetaProperties(java.util.Map<java.lang.String, java.lang.Object> allAtOnce)
    
    Add a Map of meta properties all at once.
    Parameters:
    allAtOnce - Map of meta properties to add
  - void clearMetaProperties()
    
    Remove all meta properties associated to this Column.
  - int compareTo(java.lang.Comparable that)
  - boolean equals(java.lang.Object that)
  - java.lang.String getColumnName()
    
    Get the optional name of a column. Since names are optional they are stored within meta-properties. Any column used on any type of axis can have a name.
    Returns:
    String name of Column if one is set, otherwise return null.
  - int getDisplayOrder()
  - long getId()
    
    Returns:
    long ID of this column. Note that the ID of a column is guaranteed to by unique within a given n-cube, but not across n-cubes.
  - java.util.Map<java.lang.String, java.lang.Object> getMetaProperties()
    
    Returns:
    Map (case insensitive keys) containing meta (additional) properties for the n-cube.
  - java.lang.Object getMetaProperty(java.lang.String key)
    
    Fetch the value associated to the passed in Key from the MetaProperties (if any exist). If none exist, null is returned.
  - java.lang.Comparable getValue()
    
    Returns:
    Comparable value of the column.
  - java.lang.Comparable getValueThatMatches()
    
    Returns:
    a value that will match this column. This returns column value if it is a DISCRETE axis column. If it is a Range axis column, the 'low' value will be returned (low is inclusive, high is exclusive). If it is a RangeSet axis column, then the first value will be returned. If it is a Range, then the low value of that Range will be returned. In all cases, the returned value can be used to match against an axis including this column and the returned value will match this column.
  - int hashCode()
  - boolean isDefault()
    
    Returns:
    boolean true if this is the Default column, false otherwise. The Default Column's value is always null.
  - java.lang.Object removeMetaProperty(java.lang.String key)
    
    Remove a meta-property entry
  - void setColumnName(java.lang.String name)
    
    Set the optional name of a column. Since names are optional they are stored within meta-properties. Any column used on any type of axis can have a name.
    Parameters:
    name - String name for column.
  - java.lang.Object setMetaProperty(java.lang.String key, java.lang.Object metaPropValue)
    
    Set (add / overwrite) a Meta Property associated to this Column.
    Parameters:
    key - String key name of meta property
    metaPropValue - Object value to associate to key
    Returns:
    prior value associated to key or null if none was associated prior
  - java.lang.String toString()

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Groovy] Class Column

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String DEFAULT_VALUE

public static final java.lang.String NAME

Constructor Detail

Column(java.lang.Comparable value, long id = 0L, java.util.Map metaProps = null, int order = -1)

Column(Column source)

Method Detail

void addMetaProperties(java.util.Map<java.lang.String, java.lang.Object> allAtOnce)

void clearMetaProperties()

int compareTo(java.lang.Comparable that)

boolean equals(java.lang.Object that)

java.lang.String getColumnName()

int getDisplayOrder()

long getId()

java.util.Map<java.lang.String, java.lang.Object> getMetaProperties()

java.lang.Object getMetaProperty(java.lang.String key)

java.lang.Comparable getValue()

java.lang.Comparable getValueThatMatches()

int hashCode()

boolean isDefault()

java.lang.Object removeMetaProperty(java.lang.String key)

void setColumnName(java.lang.String name)

java.lang.Object setMetaProperty(java.lang.String key, java.lang.Object metaPropValue)

java.lang.String toString()