StructFlattener (core API)

java.lang.Object

nz.org.riskscape.engine.output.StructFlattener

public class StructFlattener extends Object

Flattens nested Structs to allow them to be written to data sources that don't support nested data structures.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

StructFlattener.DotSeparatedNamer

Namer that produces a name that is taken from Struct.StructMember.getKey() for each segment and separated by a '.'.

static class

StructFlattener.LastMemberNamer

A StructFlattener.Namer that will use the Struct.StructMember.getKey() from the last segment as the name.

static interface

StructFlattener.Namer

A Namer can provide a name for the given segments.

static class

StructFlattener.StructMapping
Field Summary

Fields

Modifier and Type

Field

Description

static final String

SEPARATOR
Constructor Summary

Constructors

Constructor

Description

StructFlattener()
Method Summary

Modifier and Type

Method

Description

List<StructFlattener.StructMapping>

flatten(nz.org.riskscape.engine.types.Struct struct)

List<StructFlattener.StructMapping>

flatten(nz.org.riskscape.engine.types.Struct struct, StructFlattener.Namer namer)

void

shortenIfNecessary(List<StructFlattener.StructMapping> mappings, int maxLength)

Deprecated.
Ideally use a StructFlattener.Namer that does this itself.

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

Field Details
- SEPARATOR
  
  public static final String SEPARATOR
  See Also:
  
  Constant Field Values
Constructor Details
- StructFlattener
  
  public StructFlattener()
Method Details
- flatten
  
  public List<StructFlattener.StructMapping> flatten(nz.org.riskscape.engine.types.Struct struct)
- flatten
  
  public List<StructFlattener.StructMapping> flatten(nz.org.riskscape.engine.types.Struct struct, StructFlattener.Namer namer)
- shortenIfNecessary
  
  @Deprecated public void shortenIfNecessary(List<StructFlattener.StructMapping> mappings, int maxLength)
  
  Deprecated.
  Ideally use a StructFlattener.Namer that does this itself. This method is only retained for use by ShapefileWriter V1.
  
  Shorten StructFlattener.StructMapping.key if it is longer than maxLength.