ExtractionColumn (Ametys 4.3.x - API)

java.lang.Object
- org.ametys.plugins.extraction.component.ExtractionColumn

public class ExtractionColumn
extends Object

Object representing a extraction columns

Field Summary

Fields
Modifier and Type Field Description

private String _displayOptionalName

private String _fieldPath

Constructor Summary

Constructors
Constructor Description

ExtractionColumn()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getDisplayOptionalName()`	Retrieves the name of the variable controlling display of optional column
`String`	`getFieldPath()`	Retrieves the field path
`boolean`	`isOptional()`	Checks if the extraction column is optional
`void`	`setDisplayOptionalName(String displayOptionalName)`	Set the name of the variable controlling the display of optional column
`void`	`setFieldPath(String fieldPath)`	Set the field path

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

- Field Detail
  - _fieldPath
```
private String _fieldPath
```
  - _displayOptionalName
```
private String _displayOptionalName
```
- Constructor Detail
  - ExtractionColumn
```
public ExtractionColumn()
```
- Method Detail
  - getFieldPath
```
public String getFieldPath()
```
    Retrieves the field path
    
    Returns:
    
    The field path
  - setFieldPath
```
public void setFieldPath(String fieldPath)
```
    Set the field path
    
    Parameters:
    
    fieldPath - The field path to set
  - isOptional
```
public boolean isOptional()
```
    Checks if the extraction column is optional
    
    Returns:
    
    true if the column is optional, false otherwise
  - getDisplayOptionalName
```
public String getDisplayOptionalName()
```
    Retrieves the name of the variable controlling display of optional column
    
    Returns:
    
    The name of the variable
  - setDisplayOptionalName
```
public void setDisplayOptionalName(String displayOptionalName)
```
    Set the name of the variable controlling the display of optional column
    
    Parameters:
    
    displayOptionalName - The name of the variable