ReferenceAxisLoader (n-cube 4.10.0 API)

com.cedarsoftware.ncube.ReferenceAxisLoader

All Implemented Interfaces and Traits:

AxisRefProvider
```
@groovy.transform.CompileStatic
class ReferenceAxisLoader
extends java.lang.Object
```
This class loads an reference axis. This entails loading the cube containing the referenced axis, grabbing the axis columns from this cube, passing the columns to an [optional] transformer cube, and then ultimately building the axis from these columns. The source axis type, valueType, and meta properties are maintained. Any meta-properties on the referencing axis, are added to the meta-properties from the referenced axis. If both have the same key, the referring axis meta-properties take priority.
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`	`REF_APP`
`static java.lang.String`	`REF_AXIS_NAME`
`static java.lang.String`	`REF_BRANCH`
`static java.lang.String`	`REF_CUBE_NAME`
`static java.lang.String`	`REF_STATUS`
`static java.lang.String`	`REF_TENANT`
`static java.lang.String`	`REF_VERSION`
`static java.lang.String`	`TRANSFORM_APP`
`static java.lang.String`	`TRANSFORM_BRANCH`
`static java.lang.String`	`TRANSFORM_CUBE_NAME`
`static java.lang.String`	`TRANSFORM_STATUS`
`static java.lang.String`	`TRANSFORM_VERSION`

Constructor Summary

Constructors
Constructor and description
`ReferenceAxisLoader (java.lang.String containingCubeName, java.lang.String sourceAxisName, java.util.Map<java.lang.String, java.lang.Object> args)` @param containingCubeName String name of cube that holds the 'pointer' (referring) axis

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`load(Axis axis)` Axis calls this method to load itself from this AxisRefProvider.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), 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 REF_APP
  - public static final java.lang.String REF_AXIS_NAME
  - public static final java.lang.String REF_BRANCH
  - public static final java.lang.String REF_CUBE_NAME
  - public static final java.lang.String REF_STATUS
  - public static final java.lang.String REF_TENANT
  - public static final java.lang.String REF_VERSION
  - public static final java.lang.String TRANSFORM_APP
  - public static final java.lang.String TRANSFORM_BRANCH
  - public static final java.lang.String TRANSFORM_CUBE_NAME
  - public static final java.lang.String TRANSFORM_STATUS
  - public static final java.lang.String TRANSFORM_VERSION
- Constructor Detail
  - ReferenceAxisLoader(java.lang.String containingCubeName, java.lang.String sourceAxisName, java.util.Map<java.lang.String, java.lang.Object> args)
    
    Parameters:
    containingCubeName - String name of cube that holds the 'pointer' (referring) axis
    sourceAxisName - String name of the referring axis
    args - Map containing all the key-value pairs to describe the referenced n-cube + axis and an optional reference to a transformation cube.
    required keys: sourceTenant, sourceApp, sourceVersion, sourceStatus, sourceBranch, referenceCubeName, referenceAxisName optional keys (transformer): transformApp, transformVersion, transformStatus, transformBranch, transformCubeName
- Method Detail
  - void load(Axis axis)
    
    Axis calls this method to load itself from this AxisRefProvider.
    Parameters:
    axis - Axis to 'fill-up' from the reference and 'transform' from the optional transformer.

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Groovy] Class ReferenceAxisLoader

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String REF_APP

public static final java.lang.String REF_AXIS_NAME

public static final java.lang.String REF_BRANCH

public static final java.lang.String REF_CUBE_NAME

public static final java.lang.String REF_STATUS

public static final java.lang.String REF_TENANT

public static final java.lang.String REF_VERSION

public static final java.lang.String TRANSFORM_APP

public static final java.lang.String TRANSFORM_BRANCH

public static final java.lang.String TRANSFORM_CUBE_NAME

public static final java.lang.String TRANSFORM_STATUS

public static final java.lang.String TRANSFORM_VERSION

Constructor Detail

ReferenceAxisLoader(java.lang.String containingCubeName, java.lang.String sourceAxisName, java.util.Map<java.lang.String, java.lang.Object> args)

Method Detail

void load(Axis axis)