Package com.storedobject.core

Class Link<L extends StoredObject>

java.lang.Object

com.storedobject.core.Link<L>

Type Parameters:

L - Type of the child object.

public class Link<L extends StoredObject>
extends Object

A class to represent a link of the master object to a child object.

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
Link(Class<? extends StoredObject> masterClass)	Creates a new Link object with the specified master class.

Method Summary

Modifier and Type	Method	Description
static Link<?>	create(Class<? extends StoredObject> masterClass, String linkDetails)	Creates a new Link object based on the specified master class and link details.
static List<Link<?>>	createList(Class<? extends StoredObject> masterClass)	Creates a list of Link objects associated with the specified master class.
static List<Link<?>>	createList(Class<? extends StoredObject> masterClass, StringList extraLinks)	Creates a list of Link objects associated with the specified master class and additional link details.
boolean	equals(Object another)
StringList	getBrowseColumns()	Retrieves the list of columns to be displayed in a browser for this link.
String	getCondition()	Retrieves the condition associated with this link.
Class<L>	getLinkClass()	Retrieves the class type of the link associated with this object.
Predicate<L>	getLoadPredicate()	Retrieves the predicate used to evaluate load conditions.
Class<? extends StoredObject>	getMasterClass()	Retrieves the class of the master object associated with this link.
String	getName()	Retrieves the name associated with this link.
Class<L>	getObjectClass()	Deprecated. Use getLinkClass() instead.
String	getOrderBy()	Retrieves the order by clause for this link.
int	getType()	Retrieves the link type.
boolean	isAny()	Checks if the 'any' flag is true.
boolean	isDetail()	Determines if the link class is a detail of the specified master class.
boolean	isDetailOf(Class<? extends StoredObject> masterClass)	Determines whether the current class is a detail of the specified master class.
boolean	isReadOnly()	Checks if the object is in a read-only state.
ObjectIterator<L>	list(Id master)	Retrieves an iterator over a collection of objects linked to the specified master ID.
ObjectIterator<L>	list(StoredObject master)	Creates an iterator for a list of objects linked to the specified master object.
Query	query(StoredObject master)	Constructs and executes a query to retrieve linked objects from the specified StoredObject.
void	setAny()	Set the "any" flag to specify whether any sun-classes of the link class should be included.
void	setBrowserColumns(StringList columns)	Sets the browser columns for this link using a StringList of column names.
void	setBrowserColumns(String columns)	Sets the browser columns for this link.
void	setCondition(String condition)	Sets the condition associated with this link.
void	setLinkClass(Class<L> linkClass)	Sets the class type of the link associated with this object.
void	setLinkClass(String className)	Sets the class type of the link associated with this object using the class name.
void	setLoadPredicate(Predicate<L> loadPredicate)	Sets the predicate used to determine whether a load operation should be performed for a given object of type L.
void	setName(String name)	Sets the name associated with this link.
void	setObjectClass(Class<L> linkClass)	Deprecated. Use setLinkClass(Class) instead.
void	setObjectClass(String className)	Deprecated. Use setLinkClass(String) instead.
void	setOrderBy(String orderBy)	Sets the order by clause for this link.
void	setReadOnly(boolean readOnly)	Sets the read-only status of the link.
void	setType(int type)	Sets the type for this link.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Link

public Link(Class<? extends StoredObject> masterClass)

Creates a new Link object with the specified master class.

Parameters:

masterClass - the class of the master object with which the link is associated; must be a subclass of StoredObject

Method Details

create

public static Link<?> create(Class<? extends StoredObject> masterClass,
 String linkDetails)

Creates a new Link object based on the specified master class and link details.

     Format of the link details:
     Name|Class name[/Any[/Link type]]|Order by|Columns
     Name|Class name[/Link type[/Any]]Order by|Columns
 

Parameters:

masterClass - the class of the master object with which the link is associated; must be a subclass of StoredObject

linkDetails - a string defining the link details; the format of this string determines various properties of the created link

Returns:

a newly created Link object configured according to the given master class and link details

Throws:

SOClassError - if the link details are invalid for the specified master class

createList

public static List<Link<?>> createList(Class<? extends StoredObject> masterClass)

Creates a list of Link objects associated with the specified master class.

Parameters:

masterClass - the class of the master object with which the links are associated; must be a subclass of StoredObject

Returns:

a List of Link objects associated with the specified master class

createList

public static List<Link<?>> createList(Class<? extends StoredObject> masterClass,
 StringList extraLinks)

Creates a list of Link objects associated with the specified master class and additional link details.

Parameters:

masterClass - the class of the master object with which the links are associated; must be a subclass of StoredObject.

extraLinks - additional link details to be concatenated with the default links of the specified master class.

Returns:

a List of Link objects created based on the specified master class and additional link details.

getObjectClass

@Deprecated
public Class<L> getObjectClass()

Deprecated.

Use getLinkClass() instead.

Retrieves the class type of the link associated with this object.

Returns:

the Class representing the type of the link

getLinkClass

public Class<L> getLinkClass()

Retrieves the class type of the link associated with this object.

Returns:

the Class representing the type of the link

getMasterClass

public Class<? extends StoredObject> getMasterClass()

Retrieves the class of the master object associated with this link.

Returns:

the Class representing the master object type, which is a subclass of StoredObject.

setObjectClass

@Deprecated
public void setObjectClass(Class<L> linkClass)

Deprecated.

Use setLinkClass(Class) instead.

Sets the class type of the link associated with this object.

Parameters:

linkClass - the Class object representing the type of the link; must be compatible with the generic type parameter L

setLinkClass

public void setLinkClass(Class<L> linkClass)

Sets the class type of the link associated with this object.

Parameters:

linkClass - the Class object representing the type of the link; must be compatible with the generic type parameter L

setObjectClass

@Deprecated
public void setObjectClass(String className)

Deprecated.

Use setLinkClass(String) instead.

Sets the class type of the link associated with this object using the class name. The class name will be resolved to determine the corresponding class type, which must be compatible with the generic type parameter L.

Parameters:

className - the fully qualified name of the class to be set as the link class; must correspond to a valid class type

Throws:

SORuntimeException - if any unexpected error occurs during class resolution

setLinkClass

public void setLinkClass(String className)

Sets the class type of the link associated with this object using the class name. The class name will be resolved to determine the corresponding class type, which must be compatible with the generic type parameter L.

Parameters:

className - the fully qualified name of the class to be set as the link class; must correspond to a valid class type

Throws:

SORuntimeException - if any unexpected error occurs during class resolution

getName

public String getName()

Retrieves the name associated with this link.

Returns:

the name of this link as a String

setName

public void setName(String name)

Sets the name associated with this link. The given name will be modified by replacing any underscore ('_') characters with a pipe ('|') character.

Parameters:

name - the name to be set; underscores in the provided string will be replaced with pipe characters

setBrowserColumns

public void setBrowserColumns(String columns)

Sets the browser columns for this link. If the provided string is empty or null, the browser columns will be set to null. Otherwise, the string will be processed and stored as a list of columns.

Parameters:

columns - a comma-separated string representing the browser columns to be set; if the string is null or consists entirely of whitespace, the browser columns will be cleared

setBrowserColumns

public void setBrowserColumns(StringList columns)

Sets the browser columns for this link using a StringList of column names. The provided list determines which columns will be displayed in the browser.

Parameters:

columns - a StringList containing the names of the browser columns to be set; if the list is null, the browser columns will be cleared.

getBrowseColumns

public StringList getBrowseColumns()

Retrieves the list of columns to be displayed in a browser for this link. If the browser columns have not been explicitly set but the link class is defined, the columns are determined based on the attributes of the link class.

Returns:

a StringList containing the names of the browser columns, or null if no browser columns are defined and the link class is not specified.

setType

public void setType(int type)

Sets the type for this link.

Parameters:

type - the integer value representing the type to be set

getType

public int getType()

Retrieves the link type.

Returns:

the link type as an integer

setOrderBy

public void setOrderBy(String orderBy)

Sets the order by clause for this link. This determines the order in which the linked objects will be retrieved or displayed.

Parameters:

orderBy - the order by clause to be set; should be a valid string representing the desired sort order, such as a column name or a comma-separated list of column names

getOrderBy

public String getOrderBy()

Retrieves the order by clause for this link. If the order by clause has not been explicitly set but the link class is defined, the order by clause is determined based on the attributes of the link class.

Returns:

the order by clause as a String, or null if no order by clause is defined and the link class is not specified.

setCondition

public void setCondition(String condition)

Sets the condition associated with this link. This condition determines additional filtering or constraints for the linked objects.

Parameters:

condition - the condition to be set; should be a valid string representing the filtering criteria or constraints for the link.

getCondition

public String getCondition()

Retrieves the condition associated with this link. The condition specifies filtering or constraint criteria used for determining the linked objects.

Returns:

the condition as a String, or null if no condition has been set.

setLoadPredicate

public void setLoadPredicate(Predicate<L> loadPredicate)

Sets the predicate used to determine whether a load operation should be performed for a given object of type L. The provided predicate is applied during the load process to filter or control the loading mechanism. If the provided predicate is null, a default predicate that always returns true will be assigned.

Parameters:

loadPredicate - the predicate to evaluate load conditions for objects of type L, or null to use a default predicate that always returns true.

getLoadPredicate

public Predicate<L> getLoadPredicate()

Retrieves the predicate used to evaluate load conditions.

Returns:

a Predicate representing the load evaluation logic.

setAny

public void setAny()

Set the "any" flag to specify whether any sun-classes of the link class should be included.

isAny

public boolean isAny()

Checks if the 'any' flag is true. This flag indicates that any sun-classes of the link class should be included.

Returns:

true if the 'any' flag is true, false otherwise.

setReadOnly

public void setReadOnly(boolean readOnly)

Sets the read-only status of the link.

Parameters:

readOnly - a boolean value where true indicates that the link should be set to a read-only state, and false indicates that it should be writable.

isReadOnly

public boolean isReadOnly()

Checks if the object is in a read-only state.

Returns:

true if the object is read-only, false otherwise.

isDetail

public boolean isDetail()

Determines if the link class is a detail of the specified master class.

Returns:

true if the link class is a detail of the master class, false otherwise

isDetailOf

public boolean isDetailOf(Class<? extends StoredObject> masterClass)

Determines whether the current class is a detail of the specified master class.

Parameters:

masterClass - the class to check if it is the master class for the detail

Returns:

true if the current class is a detail of the specified master class, false otherwise

list

public ObjectIterator<L> list(Id master)

Retrieves an iterator over a collection of objects linked to the specified master ID. This method uses the `links` method internally.

Parameters:

master - the ID of the master element whose linked objects are to be retrieved.

Returns:

an ObjectIterator over the linked objects.

list

public ObjectIterator<L> list(StoredObject master)

Creates an iterator for a list of objects linked to the specified master object.

Parameters:

master - the master object whose linked objects are to be iterated. If the ID of the master object is null, an empty iterator is returned.

Returns:

an iterator over the objects linked to the specified master object, or an empty iterator if the master object's ID is null.

query

public Query query(StoredObject master)

Constructs and executes a query to retrieve linked objects from the specified StoredObject.

Parameters:

master - the StoredObject instance from which the links are queried

Returns:

a Query object containing the results of the link query

equals

public boolean equals(Object another)

Overrides:

equals in class Object