com.canto.cumulus

Class Layout

java.lang.Object

com.canto.cumulus.Layout

All Implemented Interfaces:

java.lang.Iterable<FieldDefinition>

public class Layout
extends java.lang.Object
implements java.lang.Iterable<FieldDefinition>

The Layout specifies the list of fields of a table.

Since:

8.0

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compares this layout to the specified object.
GUID	findFieldUID(int shortID) Returns the field UID for the given short ID.
Catalog	getCatalog() Returns the catalog for the table of this layout.
CumulusSession	getCumulusSession() Returns the current CumulusSession object.
FieldDefinition	getFieldDefinition(GUID fieldUID) Returns the FieldDefinition for the specified fieldUID or throws an Exception if that field is not contained in this layout.
java.util.Set<GUID>	getFieldUIDs() Returns the set of field UIDs that are contained in this layout.
java.util.Set<GUID>	getFieldUIDs(boolean includeVirtualFieldUIDs) Returns the set of field UIDs that are contained in this layout.
java.lang.String	getTableName() Returns the table name of the table of this layout.
boolean	hasFieldDefinition(GUID fieldUID) Returns whether the field with the specified UID is contained in this layout.
int	hashCode()
java.util.Iterator<FieldDefinition>	iterator() Return an iterator that iterates over all field definitions in this collection.
boolean	supportsSubscriptions() Returns whether the table of this layout supports item subscriptions.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

findFieldUID

public GUID findFieldUID(int shortID)

Returns the field UID for the given short ID.

Parameters:

shortID - shortID of the field

Returns:

found UID

Throws:

InvalidArgumentException - in case of an non-found short ID

Since:

8.5.2

getFieldUIDs

public java.util.Set<GUID> getFieldUIDs()

Returns the set of field UIDs that are contained in this layout.

Returns:

set of field UIDs without virtual field UIDs for base fields of multiple languages fields

Since:

8.0

getFieldUIDs

public java.util.Set<GUID> getFieldUIDs(boolean includeVirtualFieldUIDs)

Returns the set of field UIDs that are contained in this layout.

Parameters:

includeVirtualFieldUIDs - whether the virtual field UID for the base language of a multiple languages field should be included

Returns:

set of field UIDs

Since:

8.5

hasFieldDefinition

public boolean hasFieldDefinition(GUID fieldUID)

Returns whether the field with the specified UID is contained in this layout.

Parameters:

fieldUID - the UID of the field

Returns:

true if the field with the specified UID is contained in this layout

Since:

8.0

getFieldDefinition

public FieldDefinition getFieldDefinition(GUID fieldUID)
                                   throws InvalidArgumentException

Returns the FieldDefinition for the specified fieldUID or throws an Exception if that field is not contained in this layout.

Parameters:

fieldUID - the field to get the FieldDefinition for

Returns:

the FieldDefinition for the specified fieldUID

Throws:

InvalidArgumentException - if the given fieldUID is not valid for this layout

Since:

8.0

getCumulusSession

public CumulusSession getCumulusSession()

Returns the current CumulusSession object.

Returns:

the current CumulusSession object.

getCatalog

public Catalog getCatalog()

Returns the catalog for the table of this layout.

Returns:

catalog for the table of this layout.

Since:

8.0

getTableName

public java.lang.String getTableName()

Returns the table name of the table of this layout.

Returns:

table name of the table of this layout

Since:

8.0

supportsSubscriptions

public boolean supportsSubscriptions()

Returns whether the table of this layout supports item subscriptions.

Returns:

true if the table of this layout supports item subscriptions, otherwise false

Since:

9.2

iterator

public java.util.Iterator<FieldDefinition> iterator()

Return an iterator that iterates over all field definitions in this collection. This allows you to use Java 5 for-each loops that simplify your source code:

 for (FieldDefinition fieldDefinition : layout)
 {
    // use the fieldDefinition
 }
 

The iterator returned does not support the remove operation.

Specified by:

iterator in interface java.lang.Iterable<FieldDefinition>

Returns:

An iterator for all field definitions in this layout.

Since:

8.0

equals

public boolean equals(java.lang.Object o)

Compares this layout to the specified object. The result is true if and only if the argument is not null and is a Layout object that represents the same layout as this object.

Overrides:

equals in class java.lang.Object

Parameters:

o - the object to compare

Returns:

true if the layout are equal; false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object