Identifiable (reqiflib 22.02.740 API)

java.lang.Object
- com.reqdesign.reqif.Identifiable<T>

Direct Known Subclasses:

AttributeDefinition, DatatypeDefinition, EnumValue, SpecElement, SpecHierarchy, SpecType
```
public abstract class Identifiable<T extends Identifiable<?>>
extends java.lang.Object
```
This is the abstract base class providing an identification concept for ReqIF elements.
The Identifiable element provides globally unique and lifetime immutable identity to ReqIF elements. In addition, Identifiable provides change tracking for the derived ReqIF element, and provides for an optional human-readable name and an optional textual description for the derived ReqIF element.

While the longName attribute is optional from the viewpoint of Identifiable, some ReqIF elements make this long name mandatory. This fact is stated in the class description of the affected elements.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getAlternativeID()` The linkage to the optional alternative identification element.
`Children`	`getChildren()` Where this `Identifable` is the base class for `Specification` or `SpecHierarchy`, this member contains the child `SpecHierarchy` objects.
`java.lang.String`	`getDesc()` Optional additional description for the information element.
`java.lang.String`	`getIdentifier()` The lifetime immutable identifier for an instance of a ReqIF information type.
`java.util.Date`	`getLastChange()` The date and time of the last change of the information element.
`java.lang.String`	`getLastChangeText()` The date and time of the last change of the information element as a `String`.
`java.lang.String`	`getLongName()` The human-readable name for the information element.
`java.lang.String`	`getPathToRoot()` Helper function returning the path to the XML root for display in validation messages.
`ReqIFContent`	`getReqIFContent()` Reference to the owning `ReqIFContent` object.
`int`	`hashCode()`
`boolean`	`isUsed()`
`static boolean`	`isValidIdentifier(java.lang.String identifier)` Checks whether the supplied String identifier is valid XSD:ID.
`void`	`setAlternativeID(java.lang.String identifier)` Sets the `ALTERNATIVE-ID[@IDENTIFIER]` attribute to the specified value.
`void`	`setDesc(java.lang.String desc)` Sets the `@DESC` attribute to the specified value.
`void`	`setLastChange(java.util.Date lastChange)` Sets the date/time of the last change of the information element.
`void`	`setLongName(java.lang.String longName)` Sets the human-readable name for the information.
`Identifiables`	`whereUsed()`

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

- Method Detail
  - getAlternativeID
```
public java.lang.String getAlternativeID()
```
    The linkage to the optional alternative identification element.
    
    Returns:
    
    the String value of the ALTERNATIVE-ID element @IDENTIFIER attribute, can be null but not empty
  - setAlternativeID
```
public void setAlternativeID(java.lang.String identifier)
```
    Sets the ALTERNATIVE-ID[@IDENTIFIER] attribute to the specified value.
    
    Parameters:
    
    identifier - the value to set as the ALTERNATIVE-ID identifier
  - getIdentifier
```
public java.lang.String getIdentifier()
```
    The lifetime immutable identifier for an instance of a ReqIF information type.
    The value of the identifier must be a well-formed xsd:ID and must be globally unique.
    
    Returns:
    
    the identifier corresponding to @IDENTIFIER XML attribute, not null and unique
  - getDesc
```
public java.lang.String getDesc()
```
    Optional additional description for the information element.
    
    Returns:
    
    the description corresponding to the @DESC XML attribute, can be null
  - setDesc
```
public void setDesc(java.lang.String desc)
```
    Sets the @DESC attribute to the specified value.
    
    Parameters:
    
    desc - the value to set as the @DESC attribute, can be null
  - getLastChange
```
public java.util.Date getLastChange()
```
    The date and time of the last change of the information element.
    This includes the creation of the information element. lastChange is of the XML Schema data type "dateTime" that specifies the time format as CCYY-MM-DDThh:mm:ss with optional time zone indicator as a suffix ±hh:mm.
    
    Returns:
    
    the Date corresponding to the @LAST-CHANGE XML attribute, not null
  - setLastChange
```
public void setLastChange(java.util.Date lastChange)
```
    Sets the date/time of the last change of the information element. Assigns the value to the LAST-CHANGE attribute.
    
    Parameters:
    
    lastChange - the Date value to set for the @DESC attribute, not null
  - getLastChangeText
```
public java.lang.String getLastChangeText()
```
    The date and time of the last change of the information element as a String. Where the ReqIF was loaded from a file, the representation is exactly as defined in the XML file. Where the time is set using setLastChange(java.util.Date) or in the constructor, the representation is determined from the Date.
    This includes the creation of the information element. lastChange is of the XML Schema data type "dateTime" that specifies the time format as CCYY-MM-DDThh:mm:ss with optional time zone indicator as a suffix ±hh:mm.
    
    Returns:
    
    the Date corresponding to the @LAST-CHANGE XML attribute as a String, not null and not empty
  - getLongName
```
public java.lang.String getLongName()
```
    The human-readable name for the information element.
    
    Returns:
    
    the String corresponding to the @LONG-NAME XML attribute, can be null except for AttributeDefinition objects
  - setLongName
```
public void setLongName(java.lang.String longName)
```
    Sets the human-readable name for the information. Assigns the specified value to the @LONG-NAME attribute.
    
    Parameters:
    
    longName - the value to set for the @LONG-NAME attribute, can be null
  - getReqIFContent
```
public ReqIFContent getReqIFContent()
```
    Reference to the owning ReqIFContent object.
    
    Returns:
    
    the owning ReqIFContent object, not null
  - whereUsed
```
public Identifiables whereUsed()
```
    Returns:
    
    the collection of objects that reference this object, not null
  - isUsed
```
public boolean isUsed()
```
    Returns:
    
    true if this Identifiable is referenced by any other object, false otherwise
  - isValidIdentifier
```
public static boolean isValidIdentifier(java.lang.String identifier)
```
    Checks whether the supplied String identifier is valid XSD:ID.
    The type xsd:ID is used for an attribute that uniquely identifies an element in an XML document. An xsd:ID value must be an NCName. This means that it must start with a letter or underscore, and can only contain letters, digits, underscores, hyphens, and periods.
    
    Parameters:
    
    identifier - the identifier to check, can be null
    
    Returns:
    
    true if valid, false if not valid
  - getChildren
```
public Children getChildren()
```
    Where this Identifable is the base class for Specification or SpecHierarchy, this member contains the child SpecHierarchy objects. Otherwise it is null.
    
    Returns:
    
    the Children of this object when it is a Specification or SpecHierarchy, can be null
  - getPathToRoot
```
public java.lang.String getPathToRoot()
```
    Helper function returning the path to the XML root for display in validation messages.
    
    Returns:
    
    path to root, not null
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class Identifiable<T extends Identifiable<?>>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getAlternativeID

setAlternativeID

getIdentifier

getDesc

setDesc

getLastChange

setLastChange

getLastChangeText

getLongName

setLongName

getReqIFContent

whereUsed

isUsed

isValidIdentifier

getChildren

getPathToRoot

equals

hashCode