SchemaField

All Implemented Interfaces:

@Serializable() 
public final class SchemaField

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`id`
`private final String`	`description`
`private final Boolean`	`immutable`
`private final Boolean`	`system`
`private final String`	`expression`
`private final String`	`unit`

Constructor Summary

Constructors
Constructor	Description
`SchemaField(String id, String description, Boolean immutable, Boolean system, String expression, String unit)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getId()`	The technical id of the field.
`final String`	`getDescription()`	Human-readable description of the field.
`final Boolean`	`getImmutable()`	If a field NEVER changes then this can be se to true.
`final Boolean`	`getSystem()`	Some fields are system fields which means they should not be used by the application.
`final String`	`getExpression()`	The expression that defines how this Field gets its value.
`final String`	`getUnit()`	Human-readable unit of the field (like 'V' for Volt or '%' for percentage).
`String`	`toString()`

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

- Constructor Detail
  - SchemaField
```
SchemaField(String id, String description, Boolean immutable, Boolean system, String expression, String unit)
```
- Method Detail
  - getId
```
 final String getId()
```
    The technical id of the field. Must be usable as an identifier in 'all' common programming languages. So "CamelCase" (without spaces) is a good choice.
  - getDescription
```
 final String getDescription()
```
    Human-readable description of the field.
  - getImmutable
```
 final Boolean getImmutable()
```
    If a field NEVER changes then this can be se to true. This allows a library to only read this value the first time and on subsequent updates skip reading this value. An example of these are software version numbers and the scaling factor as used by SunSpec.
  - getSystem
```
 final Boolean getSystem()
```
    Some fields are system fields which means they should not be used by the application. An example of these are the scaling factor as used by SunSpec.
  - getExpression
```
 final String getExpression()
```
    The expression that defines how this Field gets its value.
  - getUnit
```
 final String getUnit()
```
    Human-readable unit of the field (like 'V' for Volt or '%' for percentage).
  - toString
```
 String toString()
```