AttributeInfo (Technia Value Components (2022.2.0) API Documentation

java.lang.Object
- com.technia.tvc.core.db.model.AttributeInfo

All Implemented Interfaces:

com.technia.tvc.core.db.model.SchemaInfo
```
public final class AttributeInfo
extends java.lang.Object
```
Contains information about an attribute.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AttributeInfo.OwnerKind
Represents the kind of owner for the attribute.

Nested Classes
Modifier and Type	Class and Description
`static class`	`AttributeInfo.OwnerKind` Represents the kind of owner for the attribute.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)` Returns true if the objects are equal.
`static boolean`	`exists(java.lang.String name)` Returns true if the given attribute exists.
`static java.util.List<AttributeInfo>`	`getAllAttributeInfos()` Returns all attributes from the database.
`static java.util.Collection<java.lang.String>`	`getAttributeNames()` Returns an unmodifiable list containing the NAMES of all the attribute types that exists in the database.
`static java.lang.String[]`	`getBooleanValues(AttributeInfo attribute, java.util.Locale locale)` Returns the translated boolean values for an attribute.
`java.util.List<java.lang.String>`	`getChoices()` Returns the accepted range values.
`java.lang.String`	`getDefault()` Returns the default value.
`DimensionInfo`	`getDimension()` Note: Dimension is a feature in Matrix 10.7+ This method will always return null if the matrix version is below that.
`boolean`	`getHasDimension()`
`static AttributeInfo`	`getInstance(java.lang.String name)` Returns an `AttributeInfo` instance encapsulating information about the requested attribute.
`static AttributeInfo`	`getLocalAttribute(java.lang.String owner, AttributeInfo.OwnerKind ownerKind, java.lang.String localName)` Returns the local attribute with the given name for the specified owner
`static java.util.Iterator<AttributeInfo>`	`getLocalAttributes()`
`static java.util.Iterator<AttributeInfo>`	`getLocalAttributes(java.lang.String localName)`
`static java.util.Iterator<AttributeInfo>`	`getLocalAttributes(java.lang.String owner, AttributeInfo.OwnerKind ownerKind)`
`java.lang.String`	`getLocalName()`
`int`	`getMaxLength()`
`java.lang.String`	`getName()` Returns the name of the admin object.
`java.lang.String`	`getOwner()`
`AttributeInfo.OwnerKind`	`getOwnerKind()`
`java.lang.String`	`getSymbolicName()` Returns the symbolic attribute name.
`int`	`getType()` Returns the attribute type.
`boolean`	`getUsesProgram()` Returns whether the attribute uses a program to retrieve choices or not.
`com.technia.tvc.core.db.model.AttributeValueType`	`getValueType()`
`boolean`	`hasChoices()`
`boolean`	`hasDimension()` Deprecated. Use `getHasDimension()` instead
`int`	`hashCode()` Returns the objects hash code.
`boolean`	`isHidden()` Returns whether the attribute is hidden or not.
`boolean`	`isLocal()`
`boolean`	`isMultiline()` Returns whether the attribute is multiline or not.
`java.lang.String`	`toString()` Returns a string representation suitable for debugging.

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

- Method Detail
  - exists
```
public static boolean exists(java.lang.String name)
                      throws TVCException
```
    Returns true if the given attribute exists.
    
    Throws:
    
    TVCException
  - getAttributeNames
```
public static java.util.Collection<java.lang.String> getAttributeNames()
                                                                throws TVCException
```
    Returns an unmodifiable list containing the NAMES of all the attribute types that exists in the database. The result of this operation will be cached, therefore - if new attributes are added at runtime, those will not be seen here unless the TVC Cache is refreshed.
    
    Throws:
    
    TVCException
  - getAllAttributeInfos
```
public static java.util.List<AttributeInfo> getAllAttributeInfos()
                                                          throws TVCException
```
    Returns all attributes from the database.
    
    Throws:
    
    TVCException
  - getInstance
```
public static AttributeInfo getInstance(java.lang.String name)
                                 throws TVCException
```
    Returns an AttributeInfo instance encapsulating information about the requested attribute.
    
    Parameters:
    
    name - The name of the attribute.
    
    Returns:
    
    An AttributeInfo instance.
    
    Throws:
    
    TVCException - If unable to retrieve attribute information in case the information has to be retrieved from the database.
  - getSymbolicName
```
public java.lang.String getSymbolicName()
```
    Returns the symbolic attribute name.
  - getType
```
public int getType()
```
    Returns the attribute type.
  - isMultiline
```
public boolean isMultiline()
```
    Returns whether the attribute is multiline or not.
  - isHidden
```
public boolean isHidden()
```
    Returns whether the attribute is hidden or not.
  - hasChoices
```
public boolean hasChoices()
```
    Returns:
    
    True if this attribute uses choices (range values)
    
    Since:
    
    6.4.2
  - getUsesProgram
```
public boolean getUsesProgram()
```
    Returns whether the attribute uses a program to retrieve choices or not.
    
    Since:
    
    4.1.0
  - getChoices
```
public java.util.List<java.lang.String> getChoices()
```
    Returns the accepted range values.
  - getDefault
```
public java.lang.String getDefault()
```
    Returns the default value.
  - getDimension
```
public DimensionInfo getDimension()
```
    Note: Dimension is a feature in Matrix 10.7+ This method will always return null if the matrix version is below that.
    
    Returns:
    
    The associated dimension, if any, otherwise null.
    
    Since:
    
    6.1.1
  - hasDimension
```
@Deprecated
public boolean hasDimension()
```
    Deprecated. Use getHasDimension() instead
    
    Returns true if this attribute has a dimension associated.
    
    Since:
    
    6.1.1
  - getHasDimension
```
public boolean getHasDimension()
```
    Returns:
    
    True if this attribute has a dimension associated
    
    Since:
    
    2012.3.0
  - isLocal
```
public boolean isLocal()
```
    Returns:
    
    True if this attribute is local, e.g. it is specific to a type, relationhip or an interface.
    
    Since:
    
    2012.3.0
  - getOwner
```
public java.lang.String getOwner()
```
    Returns:
    
    The owner of this attribute, if this attribute is local. If this is a global attribute, null is returned. The owner is the name of the type, relationship or interface, which this attribute is local for.
    
    Since:
    
    2012.3.0
  - getOwnerKind
```
public AttributeInfo.OwnerKind getOwnerKind()
```
    Returns:
    
    The kind of owner if this attribute is a local attribute. If this attribute is not local, then null is returned.
    
    Since:
    
    2012.3.0
  - getLocalName
```
public java.lang.String getLocalName()
```
    Returns:
    
    The "local" name of this attribute. If this is a global attribute, this method returns the same as getName() does
    
    Since:
    
    2012.3.0
  - getValueType
```
public com.technia.tvc.core.db.model.AttributeValueType getValueType()
```
    Returns:
    
    The type of value this attribute represents
    
    Since:
    
    2016.2.0
    
    See Also:
    
    ValueType
  - getMaxLength
```
public int getMaxLength()
```
    Returns:
    
    The maxlength of the value. Zero means unspecified.
    
    Since:
    
    2016.2.0
  - getLocalAttribute
```
public static AttributeInfo getLocalAttribute(java.lang.String owner,
                                              AttributeInfo.OwnerKind ownerKind,
                                              java.lang.String localName)
                                       throws TVCException
```
    Returns the local attribute with the given name for the specified owner
    
    Parameters:
    
    owner - The name of the owner
    
    ownerKind - The kind of owner
    
    localName - The local name
    
    Returns:
    
    The AttributeInfo, or null, if none were found
    
    Throws:
    
    TVCException - Upon errors to retrieve the attributes from the DB
    
    Since:
    
    2012.3.0
  - getLocalAttributes
```
public static java.util.Iterator<AttributeInfo> getLocalAttributes(java.lang.String owner,
                                                                   AttributeInfo.OwnerKind ownerKind)
                                                            throws TVCException
```
    Parameters:
    
    owner - The owner
    
    ownerKind - The owner kind
    
    Returns:
    
    An iterator of all AttributeInfo instances, which is local to the specified owner. If the owner does not have any local attributes, the iterator is empty.
    
    Throws:
    
    TVCException - Upon errors to retrieve the attributes from the DB
    
    Since:
    
    2012.3.0
  - getLocalAttributes
```
public static java.util.Iterator<AttributeInfo> getLocalAttributes(java.lang.String localName)
                                                            throws TVCException
```
    Parameters:
    
    localName - The local name
    
    Returns:
    
    An iterator of all AttributeInfo instances, which is local and has a local name matching the specified.
    
    Throws:
    
    TVCException - Upon errors to retrieve the attributes from the DB
    
    Since:
    
    2012.3.0
  - getLocalAttributes
```
public static java.util.Iterator<AttributeInfo> getLocalAttributes()
                                                            throws TVCException
```
    Returns:
    
    All local attributes defined in the system
    
    Throws:
    
    TVCException - Upon errors to retrieve the attributes from the DB
    
    Since:
    
    2012.3.0
  - hashCode
```
public int hashCode()
```
    Returns the objects hash code.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Returns true if the objects are equal.
  - getBooleanValues
```
public static java.lang.String[] getBooleanValues(AttributeInfo attribute,
                                                  java.util.Locale locale)
```
    Returns the translated boolean values for an attribute.
    If the attribute is null or not of type boolean, this method returns null. Otherwise, this method returns an array of length 2 were the first item is the translated value for FALSE and the second item is the translated value for TRUE.
    
    Parameters:
    
    attribute - The attribute
    
    locale - The locale
    
    Returns:
    
    An array of length 2 or null if the attribute argument is null or not representing an attribute of type boolean.
    
    Since:
    
    2012.2.0
  - getName
```
public java.lang.String getName()
```
    Returns the name of the admin object.
    
    Specified by:
    
    getName in interface com.technia.tvc.core.db.model.SchemaInfo
  - toString
```
public final java.lang.String toString()
```
    Returns a string representation suitable for debugging.
    
    Overrides:
    
    toString in class java.lang.Object

Class AttributeInfo

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

exists

getAttributeNames

getAllAttributeInfos

getInstance

getSymbolicName

getType

isMultiline

isHidden

hasChoices

getUsesProgram

getChoices

getDefault

getDimension

hasDimension

getHasDimension

isLocal

getOwner

getOwnerKind

getLocalName

getValueType

getMaxLength

getLocalAttribute

getLocalAttributes

getLocalAttributes

getLocalAttributes

hashCode

equals

getBooleanValues

getName

toString