MapSchemaType (Subject Area OMAS Server-side 1.0 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.subjectarea.generated.entities.MapSchemaType.MapSchemaType

All Implemented Interfaces:

Serializable
```
public class MapSchemaType
extends Object
implements Serializable
```
MapSchemaType entity in the Subject Area OMAS. A schema type for a map between a key and value.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Set<String>`	`ATTRIBUTE_NAMES_SET`
`static String[]`	`ATTRIBUTE_NAMES_SET_VALUES`
`static Set<String>`	`ENUM_NAMES_SET`
`static String[]`	`ENUM_NAMES_SET_VALUES`
`static Set<String>`	`MAP_NAMES_SET`
`static String[]`	`MAP_NAMES_SET_VALUES`
`static Set<String>`	`PROPERTY_NAMES_SET`
`static String[]`	`PROPERTY_NAMES_SET_VALUES`

Constructor Summary

Constructors
Constructor and Description

MapSchemaType()

Constructors
Constructor and Description
`MapSchemaType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`Map<String,String>`	`getAdditionalProperties()` {@literal Additional properties for the element.
`String`	`getAuthor()` {@literal User name of the person or process that created the schema type.
`List<Classification>`	`getClassifications()` Classifications
`String`	`getDisplayName()` {@literal Display name for the schema type.
`Date`	`getEffectiveFromTime()` Return the date/time that this MapSchemaType should start to be used (null means it can be used from creationTime).
`Date`	`getEffectiveToTime()` Return the date/time that this MapSchemaType should no longer be used.
`String`	`getEncodingStandard()` {@literal Format of the schema.
`Map<String,Object>`	`getExtraAttributes()` Get the extra attributes - ones that are in addition to the standard types.
`Map<String,Classification>`	`getExtraClassifications()` Extra classifications are classifications that are not in the open metadata model - we include the OMRS Classifications.
`String`	`getQualifiedName()` {@literal Unique identifier for the entity.
`SystemAttributes`	`getSystemAttributes()` Get the system attributes
`String`	`getUsage()` {@literal Guidance on how the schema should be used.
`String`	`getVersionNumber()` {@literal Version of the schema type.
`int`	`hashCode()`
`void`	`setAdditionalProperties(Map<String,String> additionalProperties)`
`void`	`setAuthor(String author)`
`void`	`setClassifications(List<Classification> classifications)`
`void`	`setDisplayName(String displayName)`
`void`	`setEffectiveFromTime(Date effectiveFromTime)`
`void`	`setEffectiveToTime(Date effectiveToTime)`
`void`	`setEncodingStandard(String encodingStandard)`
`void`	`setExtraAttributes(Map<String,Object> extraAttributes)`
`void`	`setExtraClassifications(Map<String,Classification> extraClassifications)`
`void`	`setQualifiedName(String qualifiedName)`
`void`	`setSystemAttributes(SystemAttributes systemAttributes)`
`void`	`setUsage(String usage)`
`void`	`setVersionNumber(String versionNumber)`
`String`	`toString()`
`StringBuilder`	`toString(StringBuilder sb)`

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

Field Detail

PROPERTY_NAMES_SET_VALUES

public static final String[] PROPERTY_NAMES_SET_VALUES

ATTRIBUTE_NAMES_SET_VALUES

public static final String[] ATTRIBUTE_NAMES_SET_VALUES

ENUM_NAMES_SET_VALUES

public static final String[] ENUM_NAMES_SET_VALUES

MAP_NAMES_SET_VALUES

public static final String[] MAP_NAMES_SET_VALUES

PROPERTY_NAMES_SET

public static final Set<String> PROPERTY_NAMES_SET

ATTRIBUTE_NAMES_SET

public static final Set<String> ATTRIBUTE_NAMES_SET

ENUM_NAMES_SET

public static final Set<String> ENUM_NAMES_SET

MAP_NAMES_SET

public static final Set<String> MAP_NAMES_SET

Constructor Detail
- MapSchemaType
```
public MapSchemaType()
```

Method Detail
- getSystemAttributes
```
public SystemAttributes getSystemAttributes()
```
  Get the system attributes
  
  Returns:
  
  SystemAttributes if populated, null otherwise.
- setSystemAttributes
```
public void setSystemAttributes(SystemAttributes systemAttributes)
```
- getDisplayName
```
public String getDisplayName()
```
  Display name for the schema type.
  
  Returns:
  
  String
- setDisplayName
```
public void setDisplayName(String displayName)
```
- getVersionNumber
```
public String getVersionNumber()
```
  Version of the schema type.
  
  Returns:
  
  String
- setVersionNumber
```
public void setVersionNumber(String versionNumber)
```
- getAuthor
```
public String getAuthor()
```
  User name of the person or process that created the schema type.
  
  Returns:
  
  String
- setAuthor
```
public void setAuthor(String author)
```
- getUsage
```
public String getUsage()
```
  Guidance on how the schema should be used.
  
  Returns:
  
  String
- setUsage
```
public void setUsage(String usage)
```
- getEncodingStandard
```
public String getEncodingStandard()
```
  Format of the schema.
  
  Returns:
  
  String
- setEncodingStandard
```
public void setEncodingStandard(String encodingStandard)
```
- getQualifiedName
```
public String getQualifiedName()
```
  Unique identifier for the entity.
  
  Returns:
  
  String
- setQualifiedName
```
public void setQualifiedName(String qualifiedName)
```
- getAdditionalProperties
```
public Map<String,String> getAdditionalProperties()
```
  Additional properties for the element.
  
  Returns:
  
  {@code Map<String,String> }
- setAdditionalProperties
```
public void setAdditionalProperties(Map<String,String> additionalProperties)
```
- getEffectiveFromTime
```
public Date getEffectiveFromTime()
```
  Return the date/time that this MapSchemaType should start to be used (null means it can be used from creationTime).
  
  Returns:
  
  Date the MapSchemaType becomes effective.
- setEffectiveFromTime
```
public void setEffectiveFromTime(Date effectiveFromTime)
```
- getEffectiveToTime
```
public Date getEffectiveToTime()
```
  Return the date/time that this MapSchemaType should no longer be used.
  
  Returns:
  
  Date the MapSchemaType stops being effective.
- setEffectiveToTime
```
public void setEffectiveToTime(Date effectiveToTime)
```
- setExtraAttributes
```
public void setExtraAttributes(Map<String,Object> extraAttributes)
```
- setClassifications
```
public void setClassifications(List<Classification> classifications)
```
- getExtraAttributes
```
public Map<String,Object> getExtraAttributes()
```
  Get the extra attributes - ones that are in addition to the standard types.
  
  Returns:
  
  map of attributes, null if there are none
- getClassifications
```
public List<Classification> getClassifications()
```
  Classifications
  
  Returns:
  
  List of Classifications, null if there are none
- getExtraClassifications
```
public Map<String,Classification> getExtraClassifications()
```
  Extra classifications are classifications that are not in the open metadata model - we include the OMRS Classifications.
  
  Returns:
  
  Map of classifications with the classification Name as the map key
- setExtraClassifications
```
public void setExtraClassifications(Map<String,Classification> extraClassifications)
```
- toString
```
public StringBuilder toString(StringBuilder sb)
```
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class Object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object

Class MapSchemaType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROPERTY_NAMES_SET_VALUES

ATTRIBUTE_NAMES_SET_VALUES

ENUM_NAMES_SET_VALUES

MAP_NAMES_SET_VALUES

PROPERTY_NAMES_SET

ATTRIBUTE_NAMES_SET

ENUM_NAMES_SET

MAP_NAMES_SET

Constructor Detail

MapSchemaType

Method Detail

getSystemAttributes

setSystemAttributes

getDisplayName

setDisplayName

getVersionNumber

setVersionNumber

getAuthor

setAuthor

getUsage

setUsage

getEncodingStandard

setEncodingStandard

getQualifiedName

setQualifiedName

getAdditionalProperties

setAdditionalProperties

getEffectiveFromTime

setEffectiveFromTime

getEffectiveToTime

setEffectiveToTime

setExtraAttributes

setClassifications

getExtraAttributes

getClassifications

getExtraClassifications

setExtraClassifications

toString

equals

hashCode

toString