org.deduced
Class OrderedListInformation

java.lang.Object
  org.deduced.OrderedListInformation

public class OrderedListInformation
extends java.lang.Object

OrderedListInformation is a utility class used to extract information from an ordered list and validate it.

Author:

Steve McDuff

Field Summary

private PropertyCollection	list the ordered list
private PropertyCollection	listType the list type
private PropertyCollection	orderingType the list ordering type
private PropertyCollection	valueInstance the ordering value instance
private java.lang.Object	valueKey the ordering value key

Constructor Summary

OrderedListInformation(PropertyCollection orderedList)
OrderedListInformation constructor

Method Summary

PropertyCollection	getList() get List
PropertyCollection	getListType() get List Type
PropertyCollection	getOrderingInstance() get Ordering Instance
java.lang.Object	getOrderingKey() get Ordering Key
PropertyCollection	getOrderingType() get Ordering Type
PropertyCollection	getValueInstance() get Value Instance
java.lang.Object	getValueKey() get Value Key
void	validateAddOperationOnOrderedList() validate that Add Operation On the analyzed Ordered List will be successful.

Methods inherited from class java.lang.Object

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

Field Detail

list

private final PropertyCollection list

the ordered list

listType

private final PropertyCollection listType

the list type

orderingType

private final PropertyCollection orderingType

the list ordering type

valueInstance

private final PropertyCollection valueInstance

the ordering value instance

valueKey

private final java.lang.Object valueKey

the ordering value key

Constructor Detail

OrderedListInformation

public OrderedListInformation(PropertyCollection orderedList)

OrderedListInformation constructor

Parameters:

orderedList - the ordered list to analyze

Method Detail

getOrderingInstance

public PropertyCollection getOrderingInstance()

get Ordering Instance

Returns:

the ordering instances

getOrderingKey

public java.lang.Object getOrderingKey()

get Ordering Key

Returns:

the ordering key

getList

public PropertyCollection getList()

get List

Returns:

the list being analyzed

getListType

public PropertyCollection getListType()

get List Type

Returns:

the ordered list type

getOrderingType

public PropertyCollection getOrderingType()

get Ordering Type

Returns:

the list ordering type

getValueInstance

public PropertyCollection getValueInstance()

get Value Instance

Returns:

the ordered value instance

getValueKey

public java.lang.Object getValueKey()

get Value Key

Returns:

the value instance key

validateAddOperationOnOrderedList

public void validateAddOperationOnOrderedList()

validate that Add Operation On the analyzed Ordered List will be successful.

Throws:

java.lang.IllegalArgumentException - if the ordered list isn't valid to receive an add operation.