IndexList (eMetrykant 0.4.2 API)

java.lang.Object
- java.lang.Enum<IndexList>
- - pl.koder95.eme.dfs.IndexList

All Implemented Interfaces:

Serializable, Comparable<IndexList>, IndexContainer
```
public enum IndexList
extends Enum<IndexList>
implements IndexContainer
```
Zawiera wszystkie typy ksiąg i zawierających się w nich zbiorach indeksów.

Since:

0.1.11

Version:

0.4.1, 2021-11-07

Author:

Kamil Jan Mularski [@koder95]

Enum Constant Summary

Enum Constants
Enum Constant and Description
`LIBER_BAPTISMORUM` Zbiór indeksów osób ochrzczonych.
`LIBER_CONFIRMATORUM` Zbiór indeksów osób bierzmowanych.
`LIBER_DEFUNCTORUM` Zbiór indeksów osób zmarłych.
`LIBER_MATRIMONIORUM` Zbiór indeksów osób zaślubionych.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Usuwa wczytane dane i zwalnia pamięć dla potencjalnie nowych danych.
`Index`	`get(int id)`
`Index`	`getFirst()`
`Index`	`getLast()`
`List<Index>`	`getLoaded()`
`String`	`getName()`
`Index`	`getNext(Index i)`
`Index`	`getPrev(Index i)`
`void`	`load()` Wczytuje z dysku indeksy zapisane w pliku XML.
`int`	`size()`
`static IndexList`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static IndexList[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - LIBER_BAPTISMORUM
```
public static final IndexList LIBER_BAPTISMORUM
```
    Zbiór indeksów osób ochrzczonych. Indeksy zawierają dane: nazwisko, imiona, nr aktu, rok chrztu.
  - LIBER_CONFIRMATORUM
```
public static final IndexList LIBER_CONFIRMATORUM
```
    Zbiór indeksów osób bierzmowanych. Indeksy zawierają dane: nazwisko, imiona, nr aktu, rok bierzmowania.
  - LIBER_MATRIMONIORUM
```
public static final IndexList LIBER_MATRIMONIORUM
```
    Zbiór indeksów osób zaślubionych. Indeksy zawierają dane: nazwisko męża, imiona męża, nazwisko panieńskie żony, imiona żony, nr aktu, rok ślubu.
  - LIBER_DEFUNCTORUM
```
public static final IndexList LIBER_DEFUNCTORUM
```
    Zbiór indeksów osób zmarłych. Indeksy zawierają dane: nazwisko, imiona, nr aktu, rok śmierci.
- Method Detail
  - values
```
public static IndexList[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (IndexList c : IndexList.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static IndexList valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - get
```
public Index get(int id)
```
    Specified by:
    
    get in interface IndexContainer
    
    Parameters:
    
    id - identyfikator > 0
    
    Returns:
    
    indeks
  - getLoaded
```
public List<Index> getLoaded()
```
    Specified by:
    
    getLoaded in interface IndexContainer
    
    Returns:
    
    lista wczytanych indeksów
  - load
```
public void load()
```
    Wczytuje z dysku indeksy zapisane w pliku XML.
  - getName
```
public String getName()
```
    Returns:
    
    nazwa księgi
  - size
```
public int size()
```
    Specified by:
    
    size in interface IndexContainer
    
    Returns:
    
    liczba indeksów wczytanych oraz ostatni utworzony identyfikator
  - getFirst
```
public Index getFirst()
```
    Specified by:
    
    getFirst in interface IndexContainer
    
    Returns:
    
    pierwszy indeks
  - getNext
```
public Index getNext(Index i)
```
    Parameters:
    
    i - indeks
    
    Returns:
    
    kolejny indeks
  - getPrev
```
public Index getPrev(Index i)
```
    Parameters:
    
    i - indeks
    
    Returns:
    
    poprzedni indeks
  - getLast
```
public Index getLast()
```
    Specified by:
    
    getLast in interface IndexContainer
    
    Returns:
    
    ostatni indeks
  - clear
```
public void clear()
```
    Description copied from interface: IndexContainer
    
    Usuwa wczytane dane i zwalnia pamięć dla potencjalnie nowych danych.
    
    Specified by:
    
    clear in interface IndexContainer

Enum IndexList

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

LIBER_BAPTISMORUM

LIBER_CONFIRMATORUM

LIBER_MATRIMONIORUM

LIBER_DEFUNCTORUM

Method Detail

values

valueOf

get

getLoaded

load

getName

size

getFirst

getNext

getPrev

getLast

clear