Heading

java.lang.Object
- be.SIRAPRISE.typeimplementations.Heading

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable
```
public class Heading
extends java.lang.Object
implements java.io.Externalizable
```
A Heading maps attribute names onto typenames.

Author:

Erwin Smout

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Heading()` Deprecated. - constructor is defined exclusively for the Externalizable() machinery.
`Heading(java.util.Map<NameIdentifier,TypeDeclaration> attributesMapping, boolean dummy)` Creates the Heading
`Heading(java.util.Map<java.lang.String,TypeDeclaration> attributesMapping)` Deprecated. - replace with the constructor that takes a Map with NameIdentifiers as keys

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Heading`	`computeIntersectionHeading(Heading thisHeading, Heading otherHeading)` Gets the heading of the result when intersecting this relation type with the given relation type.
`static Heading`	`computeJoinHeading(Heading thisHeading, Heading otherHeading)` Gets The Heading of the relation that is the result of joining a relation of this heading type with a relation of the given one
`boolean`	`containsAttribute(NameIdentifier attributeName)` Checks whether an attribute of the given name appears in the heading
`boolean`	`containsAttribute(java.lang.String attributeName)` Deprecated. - replace with the method that takes a NameIdentifier as argument
`boolean`	`equals(java.lang.Object obj)` Two headings are equal if and only if they represent the same attribute to type mappings
`boolean`	`equalsHeading(Heading obj)` Compares this heading for equality with an other one.
`MyReadOnlySet<NameIdentifier>`	`getAllIntervalTypedAttributeNameIdentifiers()` Gets the set of names of attributes in this heading that are interval-typed.
`java.util.LinkedList<NameIdentifier>`	`getAllIntervalTypedAttributeNameIdentifiersList()` Gets the in-lexicographical-order list of names of attributes in this heading that are interval-typed.
`MyReadOnlySet<java.lang.String>`	`getAllIntervalTypedAttributeNames()` Deprecated. - replace with the method that returns a set of NameIdentifiers
`java.util.LinkedList<java.lang.String>`	`getAllIntervalTypedAttributeNamesList()` Deprecated. - replace with `getAllIntervalTypedAttributeNameIdentifiersList()`
`MyReadOnlySet<NameIdentifier>`	`getAllNonIntervalTypedAttributeNameIdentifiers()` Gets the set of names of attributes in this heading that are not interval-typed.
`MyReadOnlySet<java.lang.String>`	`getAllNonIntervalTypedAttributeNames()` Deprecated. - replace with `getAllIntervalTypedAttributeNameIdentifiers()`
`MyReadOnlyMap<NameIdentifier,TypeDeclaration>`	`getAttributeIdentifiersMapping()` Gets The mapping defining the attributes that are part of the Heading and their corresponding types
`MyReadOnlySet<NameIdentifier>`	`getAttributeNameIdentifiers()` Gets The set of attribute names
`MyReadOnlySet<java.lang.String>`	`getAttributeNames()` Deprecated. - replace with the method that returns NameIdentifier sets
`MyReadOnlyMap<java.lang.String,TypeDeclaration>`	`getAttributesMapping()` Deprecated. - replace with `getAttributeIdentifiersMapping()`
`Heading`	`getCommonSubTypesHHeading(Heading h2)` Gets a heading that has the same attribute names as this heading h2, but where each type declaration is the least specific subtype of the types of that attribute in this heading and h2, respectively.
`static Heading`	`getCommonSubTypesHHeading(Heading h1, Heading h2)` Gets a heading that has the same attribute names as heading 1 and 2, but where each type declaration is the least specific subtype of the types of that attribute in headings 1 and 2, respectively.
`static java.util.Map<NameIdentifier,TypeDeclaration>`	`getCommonSuperTypesHeading(Heading h1, Heading h2)` Deprecated. - replace with getCommonSuperTypesHHeading, which returns a Heading object instead of requiring the user to create one himself
`Heading`	`getCommonSuperTypesHHeading(Heading h2)` Gets a heading that has the same attribute names as heading 1 and 2, but where each type declaration is the most specific supertype of the types of that attribute in headings 1 and 2, respectively.
`static Heading`	`getCommonSuperTypesHHeading(Heading h1, Heading h2)` Gets a heading that has the same attribute names as heading 1 and 2, but where each type declaration is the most specific supertype of the types of that attribute in headings 1 and 2, respectively.
`int`	`getDegree()` Gets the degree of the Heading
`java.util.Set<java.util.Map.Entry<java.lang.String,TypeDeclaration>>`	`getEntries()` Deprecated. - replace with `getEntriesWithIdentifier()`
`java.util.Set<java.util.Map.Entry<NameIdentifier,TypeDeclaration>>`	`getEntriesWithIdentifier()` Gets the set of Map Entries of this Heading's attributeName-to-TypeDeclaration mapping
`Heading`	`getHeading(NameIdentifier attributeName)` Gets the heading object defining the nonscalar (relation/tuple) type of the named attribute, or null if the attribute is scalar
`Heading`	`getHeading(java.lang.String attributeName)` Deprecated. - replace with the method that takes a NameIdentifier as argument
`TypeDeclaration`	`getTypeDeclaration(NameIdentifier attributeName)` Gets the TypeDeclaration object corresponding to the named attribute.
`TypeDeclaration`	`getTypeDeclaration(java.lang.String attributeName)` Deprecated. deprecated
`java.util.Collection<TypeDeclaration>`	`getTypeDeclarations()` Gets The set of attribute names
`TypeDeclaration`	`getTypeDeclarationWithoutException(NameIdentifier attributeName)` Gets the TypeDeclaration object corresponding to the named attribute.
`TypeDeclaration`	`getTypeDeclarationWithoutException(java.lang.String attributeName)` Deprecated. - replace with the method that takes a NameIdentifier as argument
`NameIdentifier`	`getTypeName(NameIdentifier attributeName)` Gets the typename of the named attribute.
`java.lang.String`	`getTypeName(java.lang.String attributeName)` Deprecated. - replace with `getTypeName(NameIdentifier)`
`int`	`hashCode()`
`boolean`	`hasIntervals()` Gets the intervaltypes indicator
`boolean`	`isNonScalarSubTypeOf(Heading heading)` Checks whether this heading represents/defines a nonscalar subtype of the given one.
`boolean`	`isStrictUnionCompatibleWith(Heading other)` Checks if the heading of another Relvar is exactly the same as this one : The set of attribute names in the other heading is equal to the set of attribute names in this heading The Type associated with each attribute name is the same in both headings
`java.lang.String`	`print()` Gets the heading specification in textual format HEADING(ATTRIBUTENAME(TYPENAME)RELATIONTYPEDATTRIBUTENAME(RELATION(HEADING(...))))
`java.lang.String`	`printXML()` Gets the heading specification in XML style
`void`	`readExternal(java.io.ObjectInput in)`
`Heading`	`subHeadingExcluding(java.util.Collection<NameIdentifier> attributeNames, boolean dummy)` Gets a Heading that includes only the attribute definitions from this Heading whose attribute names do not appear in the given set
`Heading`	`subHeadingExcluding(java.util.Collection<java.lang.String> attributeNames)` Deprecated. - replace with `subHeadingExcluding(Collection, boolean)`
`Heading`	`subHeadingIncluding(java.util.Set<NameIdentifier> attributeNames, boolean dummy)` Gets a Heading that includes only the attribute definitions from this Heading whose attribute names appear in the given set
`Heading`	`subHeadingIncluding(java.util.Set<java.lang.String> attributeNames)` Deprecated. - replace with `subHeadingIncluding(Set, boolean)`
`void`	`toStream1_0(java.io.DataOutputStream outputStream)` Writes the heading to an outputstream in the V1.0 format
`java.lang.String`	`toString()`
`void`	`writeExternal(java.io.ObjectOutput out)`

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

- Constructor Detail
  - Heading
```
@Deprecated
public Heading()
```
    Deprecated. - constructor is defined exclusively for the Externalizable() machinery.
    
    Creates the Heading for the Externalizable() machinery.
  - Heading
```
public Heading(java.util.Map<NameIdentifier,TypeDeclaration> attributesMapping,
               boolean dummy)
```
    Creates the Heading
    
    Parameters:
    
    attributesMapping - The mapping defining the attributes that are part of the Heading and their corresponding types
    
    dummy - unused extra parameter because there is no other way in java to distinguish constructors both using a Map argument that differs only in the generics portion
  - Heading
```
@Deprecated
public Heading(java.util.Map<java.lang.String,TypeDeclaration> attributesMapping)
```
    Deprecated. - replace with the constructor that takes a Map with NameIdentifiers as keys
    
    Creates the Heading
    
    Parameters:
    
    attributesMapping - The mapping defining the attributes that are part of the Heading and their corresponding types
- Method Detail
  - computeIntersectionHeading
```
public static Heading computeIntersectionHeading(Heading thisHeading,
                                                 Heading otherHeading)
                                          throws NotFoundException
```
    Gets the heading of the result when intersecting this relation type with the given relation type. Applicable rules are :
    - The set of attribute names in the other heading is equal to the set of attribute names in this heading.
    - The Type associated with each attribute name has some common subtype or supertype with the type of the corresponding attribute in the other heading.
    Parameters:
    
    thisHeading - the heading of a relation involved in an intersection
    
    otherHeading - the Heading of another Relation involved in an intersection
    
    Returns:
    
    A RelvarHeading containing exactly the same set of atrributenames, where for each attributename the typedeclaration is the common subtype (if that exists) or else the common supertype of the two typedeclarations appearing for that attributename in the two headings
    
    Throws:
    
    NotFoundException - If the set of attribute names in both headings are not equal, or no common supertype exists for the two types corresponding to the same attribute name
  - computeJoinHeading
```
public static Heading computeJoinHeading(Heading thisHeading,
                                         Heading otherHeading)
                                  throws NotFoundException
```
    Gets The Heading of the relation that is the result of joining a relation of this heading type with a relation of the given one
    
    Parameters:
    
    thisHeading - The heading of a relation involved in a join
    
    otherHeading - The heading of another relation involved in a join
    
    Returns:
    
    The Heading of the relation that is the result of joining a relation of this heading type with a relation of the given one
    
    Throws:
    
    NotFoundException - if no common type can be found for attributes of the same name, that are declared to be of different types in both headings involved
  - getCommonSubTypesHHeading
```
public static Heading getCommonSubTypesHHeading(Heading h1,
                                                Heading h2)
                                         throws NotFoundException
```
    Gets a heading that has the same attribute names as heading 1 and 2, but where each type declaration is the least specific subtype of the types of that attribute in headings 1 and 2, respectively. I apologise for the stupid double H in the name, but I've opted for keeping parsimoneous with the stupid method name of the equivalent method for supertypes.
    
    Parameters:
    
    h1 - heading 1
    
    h2 - heading 2
    
    Returns:
    
    the heading that has the same attribute names as heading 1 and 2, but where each type declaration is the least specific subtype of the types of that attribute in headings 1 and 2, respectively.
    
    Throws:
    
    NotFoundException - if no such heading exists. This is the case if the attribute name sets differ, or if some attribute in the headings has respective types that do not have a common subtype.
  - getCommonSuperTypesHeading
```
@Deprecated
public static java.util.Map<NameIdentifier,TypeDeclaration> getCommonSuperTypesHeading(Heading h1,
                                                                                                   Heading h2)
                                                                                            throws NotFoundException
```
    Deprecated. - replace with getCommonSuperTypesHHeading, which returns a Heading object instead of requiring the user to create one himself
    
    Gets a heading that has the same attribute names as heading 1 and 2, but where each type declaration is the most specific supertype of the types of that attribute in headings 1 and 2, respectively.
    
    Parameters:
    
    h1 - heading 1
    
    h2 - heading 2
    
    Returns:
    
    the heading that has the same attribute names as heading 1 and 2, but where each type declaration is the most specific supertype of the types of that attribute in headings 1 and 2, respectively.
    
    Throws:
    
    NotFoundException - if no such heading exists. This is the case if the attribute name sets differ, or if some attribute in the headings has respective types that do not have a common supertype.
  - getCommonSuperTypesHHeading
```
public static Heading getCommonSuperTypesHHeading(Heading h1,
                                                  Heading h2)
                                           throws NotFoundException
```
    Gets a heading that has the same attribute names as heading 1 and 2, but where each type declaration is the most specific supertype of the types of that attribute in headings 1 and 2, respectively. I apologise for the stupid double H in the name, but the method of the same name with single H was already taken.
    
    Parameters:
    
    h1 - heading 1
    
    h2 - heading 2
    
    Returns:
    
    the heading that has the same attribute names as heading 1 and 2, but where each type declaration is the most specific supertype of the types of that attribute in headings 1 and 2, respectively.
    
    Throws:
    
    NotFoundException - if no such heading exists. This is the case if the attribute name sets differ, or if some attribute in the headings has respective types that do not have a common supertype.
  - containsAttribute
```
public final boolean containsAttribute(NameIdentifier attributeName)
```
    Checks whether an attribute of the given name appears in the heading
    
    Parameters:
    
    attributeName - the attribute name to check
    
    Returns:
    
    true if an attribute of the given name appears in the heading
  - containsAttribute
```
@Deprecated
public final boolean containsAttribute(java.lang.String attributeName)
```
    Deprecated. - replace with the method that takes a NameIdentifier as argument
    
    Checks whether an attribute of the given name appears in the heading
    
    Parameters:
    
    attributeName - the attribute name to check
    
    Returns:
    
    true if an attribute of the given name appears in the heading
  - equals
```
public final boolean equals(java.lang.Object obj)
```
    Two headings are equal if and only if they represent the same attribute to type mappings
    
    Overrides:
    
    equals in class java.lang.Object
  - equalsHeading
```
public final boolean equalsHeading(Heading obj)
```
    Compares this heading for equality with an other one. Two headings are equal if and only if they represent the same attribute to type mappings.
    
    Parameters:
    
    obj - the Heading to compare this one with.
    
    Returns:
    
    true if this Heading represents exactly the same attribute-to-type mapping as the given one.
  - getAllIntervalTypedAttributeNameIdentifiers
```
public final MyReadOnlySet<NameIdentifier> getAllIntervalTypedAttributeNameIdentifiers()
```
    Gets the set of names of attributes in this heading that are interval-typed.
    
    Returns:
    
    the set of names of attributes in this heading that are interval-typed.
  - getAllIntervalTypedAttributeNameIdentifiersList
```
public final java.util.LinkedList<NameIdentifier> getAllIntervalTypedAttributeNameIdentifiersList()
```
    Gets the in-lexicographical-order list of names of attributes in this heading that are interval-typed.
    
    Returns:
    
    the in-lexicographical-order list of names of attributes in this heading that are interval-typed.
  - getAllIntervalTypedAttributeNames
```
@Deprecated
public final MyReadOnlySet<java.lang.String> getAllIntervalTypedAttributeNames()
```
    Deprecated. - replace with the method that returns a set of NameIdentifiers
    
    Gets the set of names of attributes in this heading that are interval-typed.
    
    Returns:
    
    the set of names of attributes in this heading that are interval-typed.
  - getAllIntervalTypedAttributeNamesList
```
@Deprecated
public final java.util.LinkedList<java.lang.String> getAllIntervalTypedAttributeNamesList()
```
    Deprecated. - replace with getAllIntervalTypedAttributeNameIdentifiersList()
    
    Gets the in-lexicographical-order list of names of attributes in this heading that are interval-typed.
    
    Returns:
    
    the in-lexicographical-order list of names of attributes in this heading that are interval-typed.
  - getAllNonIntervalTypedAttributeNameIdentifiers
```
public final MyReadOnlySet<NameIdentifier> getAllNonIntervalTypedAttributeNameIdentifiers()
```
    Gets the set of names of attributes in this heading that are not interval-typed.
    
    Returns:
    
    the set of names of attributes in this heading that are not interval-typed.
  - getAllNonIntervalTypedAttributeNames
```
@Deprecated
public final MyReadOnlySet<java.lang.String> getAllNonIntervalTypedAttributeNames()
```
    Deprecated. - replace with getAllIntervalTypedAttributeNameIdentifiers()
    
    Gets the set of names of attributes in this heading that are not interval-typed.
    
    Returns:
    
    the set of names of attributes in this heading that are not interval-typed.
  - getAttributeIdentifiersMapping
```
public final MyReadOnlyMap<NameIdentifier,TypeDeclaration> getAttributeIdentifiersMapping()
```
    Gets The mapping defining the attributes that are part of the Heading and their corresponding types
    
    Returns:
    
    The mapping defining the attributes that are part of the Heading and their corresponding types
  - getAttributeNameIdentifiers
```
public final MyReadOnlySet<NameIdentifier> getAttributeNameIdentifiers()
```
    Gets The set of attribute names
    
    Returns:
    
    The set of attribute names
  - getAttributeNames
```
@Deprecated
public final MyReadOnlySet<java.lang.String> getAttributeNames()
```
    Deprecated. - replace with the method that returns NameIdentifier sets
    
    Gets The set of attribute names
    
    Returns:
    
    The set of attribute names
  - getAttributesMapping
```
@Deprecated
public final MyReadOnlyMap<java.lang.String,TypeDeclaration> getAttributesMapping()
```
    Deprecated. - replace with getAttributeIdentifiersMapping()
    
    Gets The mapping defining the attributes that are part of the Heading and their corresponding types
    
    Returns:
    
    The mapping defining the attributes that are part of the Heading and their corresponding types
  - getCommonSubTypesHHeading
```
public Heading getCommonSubTypesHHeading(Heading h2)
                                  throws NotFoundException
```
    Gets a heading that has the same attribute names as this heading h2, but where each type declaration is the least specific subtype of the types of that attribute in this heading and h2, respectively. I apologise for the stupid double H in the name, but I've opted for keeping parsimoneous with the stupid method name of the equivalent method for supertypes.
    
    Parameters:
    
    h2 - heading 2
    
    Returns:
    
    the heading that has the same attribute names as this heading and h2, but where each type declaration is the least specific subtype of the types of that attribute in this heading and h2, respectively.
    
    Throws:
    
    NotFoundException - if no such heading exists. This is the case if the attribute name sets differ, or if some attribute in the headings has respective types that do not have a common subtype.
  - getCommonSuperTypesHHeading
```
public Heading getCommonSuperTypesHHeading(Heading h2)
                                    throws NotFoundException
```
    Gets a heading that has the same attribute names as heading 1 and 2, but where each type declaration is the most specific supertype of the types of that attribute in headings 1 and 2, respectively. I apologise for the stupid double H in the name, but the method of the same name with single H was already taken.
    
    Parameters:
    
    h2 - heading 2
    
    Returns:
    
    the heading that has the same attribute names as this heading and h2, but where each type declaration is the most specific supertype of the types of that attribute in this heading and h2, respectively.
    
    Throws:
    
    NotFoundException - if no such heading exists. This is the case if the attribute name sets differ, or if some attribute in the headings has respective types that do not have a common supertype.
  - getDegree
```
public final int getDegree()
```
    Gets the degree of the Heading
    
    Returns:
    
    the degree of the Heading
  - getEntries
```
@Deprecated
public final java.util.Set<java.util.Map.Entry<java.lang.String,TypeDeclaration>> getEntries()
```
    Deprecated. - replace with getEntriesWithIdentifier()
    
    Gets the set of Map Entries of this Heading's attributeName-to-TypeDeclaration mapping
    
    Returns:
    
    the set of Map Entries of this Heading's attributeName-to-TypeDeclaration mapping
  - getEntriesWithIdentifier
```
public final java.util.Set<java.util.Map.Entry<NameIdentifier,TypeDeclaration>> getEntriesWithIdentifier()
```
    Gets the set of Map Entries of this Heading's attributeName-to-TypeDeclaration mapping
    
    Returns:
    
    the set of Map Entries of this Heading's attributeName-to-TypeDeclaration mapping
  - getHeading
```
public final Heading getHeading(NameIdentifier attributeName)
```
    Gets the heading object defining the nonscalar (relation/tuple) type of the named attribute, or null if the attribute is scalar
    
    Parameters:
    
    attributeName - The name of a relation-typed attribute whose heading is to be obtained
    
    Returns:
    
    the heading object defining the nonscalar type of the named attribute, or null if the named attribute is scalar
  - getHeading
```
@Deprecated
public final Heading getHeading(java.lang.String attributeName)
```
    Deprecated. - replace with the method that takes a NameIdentifier as argument
    
    Gets the heading object defining the nonscalar (relation/tuple) type of the named attribute, or null if the attribute is scalar
    
    Parameters:
    
    attributeName - The name of a relation-typed attribute whose heading is to be obtained
    
    Returns:
    
    the heading object defining the nonscalar type of the named attribute, or null if the named attribute is scalar
  - getTypeDeclaration
```
public final TypeDeclaration getTypeDeclaration(NameIdentifier attributeName)
                                         throws NotFoundException
```
    Gets the TypeDeclaration object corresponding to the named attribute.
    
    Parameters:
    
    attributeName - The name of the attribute whose type name is to be obtained
    
    Returns:
    
    The typename of the named attribute
    
    Throws:
    
    NotFoundException - If the heading does not contain the named attribute
  - getTypeDeclaration
```
@Deprecated
public final TypeDeclaration getTypeDeclaration(java.lang.String attributeName)
                                                     throws NotFoundException
```
    Deprecated. deprecated
    
    Gets the TypeDeclaration object corresponding to the named attribute.
    
    Parameters:
    
    attributeName - The name of the attribute whose type name is to be obtained
    
    Returns:
    
    The typename of the named attribute
    
    Throws:
    
    NotFoundException - If the heading does not contain the named attribute
  - getTypeDeclarations
```
public final java.util.Collection<TypeDeclaration> getTypeDeclarations()
```
    Gets The set of attribute names
    
    Returns:
    
    The set of attribute names
  - getTypeDeclarationWithoutException
```
public final TypeDeclaration getTypeDeclarationWithoutException(NameIdentifier attributeName)
```
    Gets the TypeDeclaration object corresponding to the named attribute.
    
    Parameters:
    
    attributeName - The name of the attribute whose type name is to be obtained
    
    Returns:
    
    The typename of the named attribute
  - getTypeDeclarationWithoutException
```
@Deprecated
public final TypeDeclaration getTypeDeclarationWithoutException(java.lang.String attributeName)
```
    Deprecated. - replace with the method that takes a NameIdentifier as argument
    
    Gets the TypeDeclaration object corresponding to the named attribute.
    
    Parameters:
    
    attributeName - The name of the attribute whose type name is to be obtained
    
    Returns:
    
    The typename of the named attribute
  - getTypeName
```
public final NameIdentifier getTypeName(NameIdentifier attributeName)
```
    Gets the typename of the named attribute. For the nonscalar types, their "generic" names are returned, i.e. without any detail about the heading.
    
    Parameters:
    
    attributeName - The name of the attribute whose type name is to be obtained
    
    Returns:
    
    The typename of the named attribute
  - getTypeName
```
@Deprecated
public final java.lang.String getTypeName(java.lang.String attributeName)
```
    Deprecated. - replace with getTypeName(NameIdentifier)
    
    Gets the typename of the named attribute. For the nonscalar types, their "generic" names are returned, i.e. without any detail about the heading.
    
    Parameters:
    
    attributeName - The name of the attribute whose type name is to be obtained
    
    Returns:
    
    The typename of the named attribute
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - hasIntervals
```
public final boolean hasIntervals()
```
    Gets the intervaltypes indicator
    
    Returns:
    
    true if this relation contains at least one interval-typed attribute
  - isNonScalarSubTypeOf
```
public boolean isNonScalarSubTypeOf(Heading heading)
```
    Checks whether this heading represents/defines a nonscalar subtype of the given one. This is the case if the attribute names set in both Headings are equal, and for all attributes in this heading, the type declarations in this heading, declare a subtype (not necessarily proper) of the corresponding type in the other one.
    
    Parameters:
    
    heading - A Heading to compare this one to for "subtype-ness".
    
    Returns:
    
    true if this heading represents/defines a nonscalar subtype of the given one, false otherwise.
  - isStrictUnionCompatibleWith
```
public final boolean isStrictUnionCompatibleWith(Heading other)
```
    Checks if the heading of another Relvar is exactly the same as this one :
    - The set of attribute names in the other heading is equal to the set of attribute names in this heading
    - The Type associated with each attribute name is the same in both headings
    Parameters:
    
    other - the Heading of another Relvar
    
    Returns:
    
    true if the other RelvarHeading contains exactly the same set of atrributename/typedeclaration pairs
  - print
```
public final java.lang.String print()
```
    Gets the heading specification in textual format HEADING(ATTRIBUTENAME(TYPENAME)RELATIONTYPEDATTRIBUTENAME(RELATION(HEADING(...))))
    
    Returns:
    
    the heading specification in textual format HEADING(ATTRIBUTENAME(TYPENAME)RELATIONTYPEDATTRIBUTENAME(RELATION(HEADING(...))))
  - printXML
```
public final java.lang.String printXML()
```
    Gets the heading specification in XML style
    
    Returns:
    
    the formatted heading specification in XML xtyle
  - readExternal
```
public final void readExternal(java.io.ObjectInput in)
                        throws java.io.IOException,
                               java.lang.ClassNotFoundException
```
    Specified by:
    
    readExternal in interface java.io.Externalizable
    
    Throws:
    
    java.io.IOException
    
    java.lang.ClassNotFoundException
  - subHeadingExcluding
```
public final Heading subHeadingExcluding(java.util.Collection<NameIdentifier> attributeNames,
                                         boolean dummy)
```
    Gets a Heading that includes only the attribute definitions from this Heading whose attribute names do not appear in the given set
    
    Parameters:
    
    attributeNames - The names of the attributes that are not to appear in the subHeading
    
    dummy - unused parameter because java has no way to distinguish method signatures by generics
    
    Returns:
    
    A Heading that includes only the attribute definitions from this Heading whose attribute names do not appear in the given set
  - subHeadingExcluding
```
@Deprecated
public final Heading subHeadingExcluding(java.util.Collection<java.lang.String> attributeNames)
```
    Deprecated. - replace with subHeadingExcluding(Collection, boolean)
    
    Gets a Heading that includes only the attribute definitions from this Heading whose attribute names do not appear in the given set
    
    Parameters:
    
    attributeNames - The names of the attributes that are not to appear in the subHeading
    
    Returns:
    
    A Heading that includes only the attribute definitions from this Heading whose attribute names do not appear in the given set
  - subHeadingIncluding
```
public final Heading subHeadingIncluding(java.util.Set<NameIdentifier> attributeNames,
                                         boolean dummy)
```
    Gets a Heading that includes only the attribute definitions from this Heading whose attribute names appear in the given set
    
    Parameters:
    
    attributeNames - The names of the attributes that are to appear in the subHeading
    
    dummy - unused parameter because java has no way to distinguish method signatures by generics
    
    Returns:
    
    A Heading that includes only the attribute definitions from this Heading whose attribute names appear in the given set
  - subHeadingIncluding
```
@Deprecated
public final Heading subHeadingIncluding(java.util.Set<java.lang.String> attributeNames)
```
    Deprecated. - replace with subHeadingIncluding(Set, boolean)
    
    Gets a Heading that includes only the attribute definitions from this Heading whose attribute names appear in the given set
    
    Parameters:
    
    attributeNames - The names of the attributes that are to appear in the subHeading
    
    Returns:
    
    A Heading that includes only the attribute definitions from this Heading whose attribute names appear in the given set
  - toStream1_0
```
public final void toStream1_0(java.io.DataOutputStream outputStream)
                       throws java.io.IOException
```
    Writes the heading to an outputstream in the V1.0 format
    
    Parameters:
    
    outputStream - the outputstream to write the heading to
    
    Throws:
    
    java.io.IOException - -
  - toString
```
public final java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - writeExternal
```
public final void writeExternal(java.io.ObjectOutput out)
                         throws java.io.IOException
```
    Specified by:
    
    writeExternal in interface java.io.Externalizable
    
    Throws:
    
    java.io.IOException

Class Heading

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Heading

Heading

Heading

Method Detail

computeIntersectionHeading

computeJoinHeading

getCommonSubTypesHHeading

getCommonSuperTypesHeading

getCommonSuperTypesHHeading

containsAttribute

containsAttribute

equals

equalsHeading

getAllIntervalTypedAttributeNameIdentifiers

getAllIntervalTypedAttributeNameIdentifiersList

getAllIntervalTypedAttributeNames

getAllIntervalTypedAttributeNamesList

getAllNonIntervalTypedAttributeNameIdentifiers

getAllNonIntervalTypedAttributeNames

getAttributeIdentifiersMapping

getAttributeNameIdentifiers

getAttributeNames

getAttributesMapping

getCommonSubTypesHHeading

getCommonSuperTypesHHeading

getDegree

getEntries

getEntriesWithIdentifier

getHeading

getHeading

getTypeDeclaration

getTypeDeclaration

getTypeDeclarations

getTypeDeclarationWithoutException

getTypeDeclarationWithoutException

getTypeName

getTypeName

hashCode

hasIntervals

isNonScalarSubTypeOf

isStrictUnionCompatibleWith

print

printXML

readExternal

subHeadingExcluding

subHeadingExcluding

subHeadingIncluding

subHeadingIncluding

toStream1_0

toString

writeExternal