public class AttributeMetadata extends Object implements Serializable
Constructor and Description |
---|
AttributeMetadata(String id,
String name,
String sasName,
String description,
int ordering,
ModelConstants.DataType dataType,
int length,
ValueListMetadata valueList,
int sortSequence,
int keySequence,
boolean required,
boolean contributesToDefine,
ModelConstants.LogicalType logicalType,
ModelConstants.AttributeScope scope,
boolean derived,
String help,
ModelConstants.AttributeState state,
boolean mustBeUnique)
It is not intended or recommended that the consumer of this API construct these objects.
|
Modifier and Type | Method and Description |
---|---|
boolean |
contributesToDefine()
Gets whether the attribute contributes to a Define-XML file.
|
boolean |
equals(Object obj) |
ModelConstants.DataType |
getDataType()
Gets the type stored by the attribute.
|
String |
getDescription()
Gets the text that is used as the label if exported to a SAS data set.
|
String |
getHelp()
Gets the text describing the purpose of the attribute.
|
String |
getId()
Gets the id of the attribute metadata.
|
int |
getKeySequence()
Gets the integer value used to indicate that the attribute is a key for the table.
|
int |
getLength()
Gets the maximum length for attribute values.
|
ModelConstants.LogicalType |
getLogicalType()
Gets the logical type that enables attribute association with application types when selecting attribute values.
|
String |
getName()
Gets the name of the attribute.
|
int |
getOrdering()
Gets the integer value that represents the display order of the attribute.
|
String |
getSasName()
Gets the variable name used when exporting to a SAS dataset.
|
ModelConstants.AttributeScope |
getScope()
Gets the attribute scope which is based on logical type.
|
int |
getSortSequence()
Gets the integer value used to perform multi-level sorting.
|
ModelConstants.AttributeState |
getState()
Gets the state of the attribute.
|
ValueListMetadata |
getValueList()
Gets the value list metadata for attributes with a predefined set of allowed values.
|
int |
hashCode() |
boolean |
isDerived()
Gets whether the attribute is derived from associated metadata.
|
boolean |
isRequired()
Gets whether the attribute is required.
|
boolean |
mustBeUnique()
Gets whether the value of the attribute must be unique from other values of the attribute.
|
String |
toString() |
public AttributeMetadata(String id, String name, String sasName, String description, int ordering, ModelConstants.DataType dataType, int length, ValueListMetadata valueList, int sortSequence, int keySequence, boolean required, boolean contributesToDefine, ModelConstants.LogicalType logicalType, ModelConstants.AttributeScope scope, boolean derived, String help, ModelConstants.AttributeState state, boolean mustBeUnique)
id
- The id of the attribute metadata.name
- The name of the attribute.sasName
- The variable name used when exporting to a SAS dataset.description
- The text that is used as the label if exported to a SAS data set.ordering
- The integer value that represents the display order of the attribute.dataType
- The type stored by the attribute.length
- The maximum length in characters for string attribute values or number of digits for numeric
attribute values.valueList
- The value list metadata for attributes with a predefined set of allowed values.sortSequence
- The integer value used to perform multi-level sorting.keySequence
- The integer value used to indicate that the attribute is a key for the table. It also provides
an ordering for the keys.required
- Whether the attribute is required.contributesToDefine
- Whether the attribute contributes to a Define-XML file.logicalType
- The logical type that enables attribute association with application types when selecting
attribute values.scope
- Based on logical type, the scope determines if attributes are global or can only be determined from
a context, such as user or principal.derived
- Whether the attribute is derived from associated metadata. For example, the count of child
objects.help
- The text describing the purpose of the attribute.state
- The state of the attribute. For example, active or retired.mustBeUnique
- Whether the value of the attribute must be unique from other values of the attribute.public String getId()
public String getName()
public String getSasName()
public String getDescription()
public int getOrdering()
public ModelConstants.DataType getDataType()
public int getLength()
public ValueListMetadata getValueList()
public int getSortSequence()
public int getKeySequence()
public boolean isRequired()
public boolean isDerived()
public boolean contributesToDefine()
public boolean mustBeUnique()
public ModelConstants.LogicalType getLogicalType()
public ModelConstants.AttributeScope getScope()
public ModelConstants.AttributeState getState()
public String getHelp()
<i>Copyright (c) 2022, SAS Institute Inc., Cary, NC, USA</i>