SortedList

java.lang.Object
- org.vishia.util.SortedList

All Implemented Interfaces:

java.lang.Iterable, java.util.Collection, java.util.List

Direct Known Subclasses:

SortedStringList
```
public abstract class SortedList
extends java.lang.Object
implements java.util.List
```
This abstract class supports sorting Objects in a list with a string-oriented key. The class may be implemented by a users class: The users class must implement the method getKey(Object). The considered types of Object should be all Types of instances, there will be added to the SortedList. Typically it may be only one special type. Write at example:
```
 class MySortedList extends SortedList
 { ...
   public String getKey(Object obj)
   { MyListItem item = (MyListItem)obj;  //casting
     return item.stringxyz;              //returns a string expression from items data.
   }
 }
 
```
The method getKey is not defined as method from the stored object, but as method from this SortedList using the object. Therefore the Object should not implement any interface, the evaluation of the object is done here. But the Object have to be from the expected type, otherwise a ClassCastException is thrown when calling getKey(falseObject).
This class based on the interface java.util.List and implements all methods from List. Inside SortedList there are a association to a list, it may be either an ArrayList or a LinkedList. Using of LinkedList means, the velocity of sorting search operations is not so fast in comparision to using a array list, but there are no limits. Default, a LinkedList is created. But by constructor of this class, you can hand over an instance of a List, it may be an Arraylist of the adequate size. It is possible to create implicite Instances of such a SortedList, using the java construct:
```
 List mySortedList = new SortedList(new ArrayList(1000))
 { public String getKey(Object obj)
   { MyListItem item = (MyListItem)obj;  //casting
     return item.stringxyz;              //returns a string expression from items data.
   }
 }
 
```
In this sample the instance mySortedList is created with the given special getKey()-Method applicated to the added items on search algoritms, but no extra class declaration is necessary. Just as, the constructor is called. You don't need an extra constructor delegating the input list to the super class. This is a optimized programming.
The binary search algorithm is used. It means, a searching of 1 item in a list of 1000 items needs 10 steps. Inside, Collections.binarySearch() is used.
In opposite to TreeMap a SortedList may have more as one object with the same key.
```
date       who      change
2007-03-07 JcHartmut implements List, now it is useable as 'normal' List from outside.
2007-03-05 JcHartmut The old version of users derivated SortedList should implement the Comparator interface,
                     but now, the Comparators are private inside. Instead a Method getKey() should be implemented.
                     This is more explicit for using. The idea of SortedList is, it is a String based sorting. 
                     The method search(String) is one of the base methods of this idea. One List can sorting
                     Objects in one sorting order, but the same Objects may be contained in another SortedList in another
                     sorting order. So the SortedList should determine the key for ordering, the sorting should not
                     depends on the sorted Objects itself. This is a concept changing without great changing in the users programming.
                     Only the new Method getKey() should be implemented. The before it required method compare() are not used anymore. 
2007-03-03 JcHartmut Constructor for List definition outside.
2006-01-07 JcHarmut  initial revision
```

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`ix`
`private java.util.List`	`list`
`protected java.util.Comparator`	`objectComparator` Instance of a Comparator which compares an Object as item from list with an input Object, used by add()
`private static long`	`serialVersionUID`
`protected java.util.Comparator`	`stringComparator` Instance of a Comparator which compares an Object as item from list with a String search key, used by search()

Constructor Summary

Constructors
Constructor and Description

SortedList()

SortedList(java.util.List theList)
Uses a list outside, may be an java.util.ArrayList or a LinkedList.

Constructors
Constructor and Description
`SortedList()`
`SortedList(java.util.List theList)` Uses a list outside, may be an java.util.ArrayList or a LinkedList.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`add(int index, java.lang.Object element)` This Method throws a RuntimeException because the adding to the list at a specified position is not concept of the SortedList.
`boolean`	`add(java.lang.Object obj)` Adds an Object independend from the existence of a object with the same key in list.
`boolean`	`addAll(java.util.Collection list)`
`boolean`	`addAll(int index, java.util.Collection c)` This Method throws a RuntimeException because the adding to the list at a specified position is not concept of the SortedList.
`boolean`	`addNew(java.lang.Object obj)` Adds only an Object if the key is not already content in list, returns false otherwise.
`void`	`addTextFile(java.io.File fileIn, java.lang.Class typeElement)` Deprecated. it is from the old implementation ... TODO
`void`	`clear()` Delegates to List inside, see java.util.List.
`int`	`compare(java.lang.Object o1, java.lang.Object o2)` The compare Method requested by interface Comparator.
`boolean`	`contains(java.lang.Object o)` Delegates to List inside, see java.util.List.
`boolean`	`containsAll(java.util.Collection c)` Delegates to List inside, see java.util.List.
`java.lang.Object`	`get(int ix)` returns the Object at the given index position.
`java.lang.Object`	`get(java.lang.String sKey)` Searches the first Object with the given Key.
`int`	`getIx()`
`abstract java.lang.String`	`getKey(java.lang.Object item)`
`int`	`indexOf(java.lang.Object o)` Delegates to List inside, see java.util.List.
`boolean`	`isEmpty()` Delegates to List inside, see java.util.List.
`java.util.Iterator`	`iterator()` Gets an iterator through the associated list.
`int`	`lastIndexOf(java.lang.Object o)` Delegates to List inside, see java.util.List.
`java.util.ListIterator`	`listIterator()` Delegates to List inside, see java.util.List.
`java.util.ListIterator`	`listIterator(int index)` Delegates to List inside, see java.util.List.
`java.lang.Object`	`remove(int index)` Delegates to List inside, see java.util.List.
`boolean`	`remove(java.lang.Object o)` Delegates to List inside, see java.util.List.
`boolean`	`removeAll(java.util.Collection c)` Delegates to List inside, see java.util.List.
`void`	`report(Report report, java.lang.String sLine)`
`boolean`	`retainAll(java.util.Collection c)` Delegates to List inside, see java.util.List.
`int`	`search(java.lang.String sKey)`
`java.lang.Object`	`set(int index, java.lang.Object element)` This Method throws a RuntimeException because the adding to the list at a specified position is not concept of the SortedList.
`int`	`size()` Returns the actual size of the list (nr of stored Objects).
`java.util.List`	`subList(int fromIndex, int toIndex)` Delegates to List inside, see java.util.List.
`java.lang.Object[]`	`toArray()` Delegates to List inside, see java.util.List.
`java.lang.Object[]`	`toArray(java.lang.Object[] a)` Delegates to List inside, see java.util.List.
`void`	`writeTextFile(java.io.File fileOut)` Deprecated. it is from the old implementation ... TODO

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

Methods inherited from interface java.util.List
equals, hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - ix
```
private int ix
```
  - list
```
private final java.util.List list
```
  - stringComparator
```
protected final java.util.Comparator stringComparator
```
    Instance of a Comparator which compares an Object as item from list with a String search key, used by search()
  - objectComparator
```
protected final java.util.Comparator objectComparator
```
    Instance of a Comparator which compares an Object as item from list with an input Object, used by add()
- Constructor Detail
  - SortedList
```
public SortedList()
```
  - SortedList
```
public SortedList(java.util.List theList)
```
    Uses a list outside, may be an java.util.ArrayList or a LinkedList.
- Method Detail
  - getKey
```
public abstract java.lang.String getKey(java.lang.Object item)
```
  - compare
```
public int compare(java.lang.Object o1,
                   java.lang.Object o2)
```
    The compare Method requested by interface Comparator. The implementation here delegates the decision about the compareable data to the abstract method getKey().
  - getIx
```
public int getIx()
```
  - size
```
public int size()
```
    Returns the actual size of the list (nr of stored Objects).
    
    Specified by:
    
    size in interface java.util.Collection
    
    Specified by:
    
    size in interface java.util.List
    
    Returns:
  - addNew
```
public boolean addNew(java.lang.Object obj)
```
    Adds only an Object if the key is not already content in list, returns false otherwise.
    
    Parameters:
    
    The - Object to add.
    
    Returns:
    
    true if success, false if an object with the same key is content always.
    
    Throws:
    
    SortedListException
  - add
```
public boolean add(java.lang.Object obj)
```
    Adds an Object independend from the existence of a object with the same key in list.
    
    Specified by:
    
    add in interface java.util.Collection
    
    Specified by:
    
    add in interface java.util.List
    
    Parameters:
    
    The - Object to add.
    
    Returns:
    
    true if success, false if an object with the same key is content always.
    
    Throws:
    
    SortedListException
  - addAll
```
public boolean addAll(java.util.Collection list)
```
    Specified by:
    
    addAll in interface java.util.Collection
    
    Specified by:
    
    addAll in interface java.util.List
  - get
```
public java.lang.Object get(java.lang.String sKey)
```
    Searches the first Object with the given Key.
    
    Parameters:
    
    sKey -
    
    Returns:
  - search
```
public int search(java.lang.String sKey)
```
  - get
```
public java.lang.Object get(int ix)
```
    returns the Object at the given index position. The index may be returned typically by calling search(String). If the ix ist negative, the Object before in key order is returned. If the key is less than all Objects, it is if the ix is -1, null will be returned
    
    Specified by:
    
    get in interface java.util.List
    
    Parameters:
    
    ix - Index of the element or negativ Index
    
    Returns:
  - report
```
public void report(Report report,
                   java.lang.String sLine)
```
  - writeTextFile
```
public void writeTextFile(java.io.File fileOut)
                   throws java.io.IOException
```
    Deprecated. it is from the old implementation ... TODO
    
    Parameters:
    
    fileOut -
    
    Throws:
    
    java.io.IOException
  - addTextFile
```
public void addTextFile(java.io.File fileIn,
                        java.lang.Class typeElement)
                 throws java.io.IOException
```
    Deprecated. it is from the old implementation ... TODO
    
    adds the textual representation of the list content from a file to the list. To convert the textual represantation into the binary image, the overloaded method 'setFromStringLine()' is used. The type of the elements in the list to be added were from baseclass 'SortedListItem', but were get by calling typeElement.newInstance(), so the requested type of element with the appropriate convert method is added.
    
    Parameters:
    
    typeElement - Class object to build a new instance for a new element of the list //@param cloneItem a blank instance of the item with the requested type
    
    Throws:
    
    java.io.IOException
  - iterator
```
public java.util.Iterator iterator()
```
    Gets an iterator through the associated list. With the iterator the elements are returned in the sorted order, because there are inputted in sorted order managed by this class.
    
    Specified by:
    
    iterator in interface java.lang.Iterable
    
    Specified by:
    
    iterator in interface java.util.Collection
    
    Specified by:
    
    iterator in interface java.util.List
  - add
```
public void add(int index,
                java.lang.Object element)
```
    This Method throws a RuntimeException because the adding to the list at a specified position is not concept of the SortedList.
    
    Specified by:
    
    add in interface java.util.List
  - addAll
```
public boolean addAll(int index,
                      java.util.Collection c)
```
    This Method throws a RuntimeException because the adding to the list at a specified position is not concept of the SortedList.
    
    Specified by:
    
    addAll in interface java.util.List
  - clear
```
public void clear()
```
    Delegates to List inside, see java.util.List.
    
    Specified by:
    
    clear in interface java.util.Collection
    
    Specified by:
    
    clear in interface java.util.List
  - contains
```
public boolean contains(java.lang.Object o)
```
    Delegates to List inside, see java.util.List.
    
    Specified by:
    
    contains in interface java.util.Collection
    
    Specified by:
    
    contains in interface java.util.List
  - containsAll
```
public boolean containsAll(java.util.Collection c)
```
    Delegates to List inside, see java.util.List.
    
    Specified by:
    
    containsAll in interface java.util.Collection
    
    Specified by:
    
    containsAll in interface java.util.List
  - indexOf
```
public int indexOf(java.lang.Object o)
```
    Delegates to List inside, see java.util.List.
    
    Specified by:
    
    indexOf in interface java.util.List
  - isEmpty
```
public boolean isEmpty()
```
    Delegates to List inside, see java.util.List.
    
    Specified by:
    
    isEmpty in interface java.util.Collection
    
    Specified by:
    
    isEmpty in interface java.util.List
  - lastIndexOf
```
public int lastIndexOf(java.lang.Object o)
```
    Delegates to List inside, see java.util.List.
    
    Specified by:
    
    lastIndexOf in interface java.util.List
  - listIterator
```
public java.util.ListIterator listIterator()
```
    Delegates to List inside, see java.util.List.
    
    Specified by:
    
    listIterator in interface java.util.List
  - listIterator
```
public java.util.ListIterator listIterator(int index)
```
    Delegates to List inside, see java.util.List.
    
    Specified by:
    
    listIterator in interface java.util.List
  - remove
```
public java.lang.Object remove(int index)
```
    Delegates to List inside, see java.util.List.
    
    Specified by:
    
    remove in interface java.util.List
  - remove
```
public boolean remove(java.lang.Object o)
```
    Delegates to List inside, see java.util.List.
    
    Specified by:
    
    remove in interface java.util.Collection
    
    Specified by:
    
    remove in interface java.util.List
  - removeAll
```
public boolean removeAll(java.util.Collection c)
```
    Delegates to List inside, see java.util.List.
    
    Specified by:
    
    removeAll in interface java.util.Collection
    
    Specified by:
    
    removeAll in interface java.util.List
  - retainAll
```
public boolean retainAll(java.util.Collection c)
```
    Delegates to List inside, see java.util.List.
    
    Specified by:
    
    retainAll in interface java.util.Collection
    
    Specified by:
    
    retainAll in interface java.util.List
  - set
```
public java.lang.Object set(int index,
                            java.lang.Object element)
```
    This Method throws a RuntimeException because the adding to the list at a specified position is not concept of the SortedList.
    
    Specified by:
    
    set in interface java.util.List
  - subList
```
public java.util.List subList(int fromIndex,
                              int toIndex)
```
    Delegates to List inside, see java.util.List.
    
    Specified by:
    
    subList in interface java.util.List
  - toArray
```
public java.lang.Object[] toArray()
```
    Delegates to List inside, see java.util.List.
    
    Specified by:
    
    toArray in interface java.util.Collection
    
    Specified by:
    
    toArray in interface java.util.List
  - toArray
```
public java.lang.Object[] toArray(java.lang.Object[] a)
```
    Delegates to List inside, see java.util.List.
    
    Specified by:
    
    toArray in interface java.util.Collection
    
    Specified by:
    
    toArray in interface java.util.List

Class SortedList

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Field Detail

serialVersionUID

ix

list

stringComparator

objectComparator

Constructor Detail

SortedList

SortedList

Method Detail

getKey

compare

getIx

size

addNew

add

addAll

get

search

get

report

writeTextFile

addTextFile

iterator

add

addAll

clear

contains

containsAll

indexOf

isEmpty

lastIndexOf

listIterator

listIterator

remove

remove

removeAll

retainAll

set

subList

toArray

toArray