UDict (EDB/Java API Specification)

java.lang.Object
- jp.ac.tokushima_u.db.utlf.content.UInstance
- - jp.ac.tokushima_u.db.utlf.content.UObject
  - - jp.ac.tokushima_u.db.utlf.content.UDict

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Object>
```
public class UDict
extends UObject
```
UDict.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String EN

static String FQEN

static String NKey
- Fields inherited from class jp.ac.tokushima_u.db.utlf.content.UInstance
  text

Fields
Modifier and Type	Field and Description
`static String`	`EN`
`static String`	`FQEN`
`static String`	`NKey`

Constructor Summary

Constructors
Constructor and Description

UDict()

Constructors
Constructor and Description
`UDict()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addNodeObject(String kn, UObject o)` Add Node Object.
`boolean`	`addNodeObject(String kn, UObject o, boolean unique)` Add Node Object.
`boolean`	`addNodeObject(UObject o, boolean unique)` Add Node Object.
`boolean`	`addNodeObject(UPath path, UObject o)` Add Node Object.
`boolean`	`addNodeObject(UPath path, UObject o, boolean unique)` Add Node Object.
`boolean`	`addObject(String kn, UObject o)`
`boolean`	`addObject(UPath path, UObject o)`
`boolean`	`addObjects(String kn, List<UObject> list)`
`UDict`	`asDict()`
`void`	`copyAllObjects(UDict d)` Copy Node Object.
`UDict`	`countObjects()` Count Number of Objects.
`UDict`	`countObjects(UDict cdict)` Count Number of Objects.
`static UDict`	`create(Element e)`
`Element`	`createElement(Document doc)`
`UDict`	`duplicate()` Duplicate Objects
`boolean`	`equivalentTo(Object o)`
`boolean`	`equivalentTo(UDict o)`
`boolean`	`equivalentTo(UObject o)`
`boolean`	`getBoolean(String kn, boolean dv)`
`boolean`	`getBoolean(String kn, boolean dv, UTLFResolver res)`
`boolean`	`getBoolean(UPath path, boolean dv)`
`boolean`	`getBoolean(UPath path, boolean dv, UTLFResolver res)`
`UDate`	`getDate(String kn, UDate dv)`
`UDate`	`getDate(String kn, UDate dv, UTLFResolver res)`
`UDate`	`getDate(UPath path, UDate dv)`
`UDate`	`getDate(UPath path, UDate dv, UTLFResolver res)`
`UDict`	`getDict(String kn)`
`UDict`	`getDict(String kn, UDict dv)`
`UDict`	`getDict(String kn, UDict dv, UTLFResolver res)` Retrieve sub dict.
`UDict`	`getDict(String kn, UTLFResolver res)`
`UDict`	`getDict(UPath path)`
`UDict`	`getDict(UPath path, UDict dv)`
`UDict`	`getDict(UPath path, UDict dv, UTLFResolver res)` Retrieve sub dict.
`UDict`	`getDict(UPath path, UTLFResolver res)`
`String`	`getEN()`
`String`	`getFQEN()`
`long`	`getInteger(String kn, long dv)`
`long`	`getInteger(String kn, long dv, UTLFResolver res)`
`long`	`getInteger(UPath path, long dv)`
`long`	`getInteger(UPath path, long dv, UTLFResolver res)`
`UKey`	`getKey(String kn)`
`List<String>`	`getKeyList()`
`Set<String>`	`getKeySet()`
`UObject`	`getNodeObject()`
`<T extends UObject> T`	`getNodeObject(Class<T> clas)`
`<T extends UObject> T`	`getNodeObject(Class<T> clas, String kn)`
`<T extends UObject> T`	`getNodeObject(Class<T> clas, UPath path)`
`<T extends UObject> T`	`getNodeObject(Class<T> clas, UPath path, UTLFResolver res)`
`UObject`	`getNodeObject(String kn)`
`UObject`	`getNodeObject(UPath path)`
`UObject`	`getNodeObject(UPath path, UTLFResolver res)`
`<T extends UObject> List<T>`	`getNodeObjectList(Class<T> clas, String key)`
`<T extends UObject> List<T>`	`getNodeObjectList(Class<T> clas, String kn, UTLFResolver res)`
`<T extends UObject> List<T>`	`getNodeObjectList(Class<T> clas, UPath path)`
`<T extends UObject> List<T>`	`getNodeObjectList(Class<T> clas, UPath path, UTLFResolver res)`
`<T extends UObject> T`	`getObject(Class<T> clas, String kn)`
`<T extends UObject> T`	`getObject(Class<T> clas, UPath path)`
`<T extends UObject> T`	`getObject(Class<T> clas, UPath path, UTLFResolver res)`
`UObject`	`getObject(String kn)`
`UObject`	`getObject(UPath path)`
`UObject`	`getObject(UPath path, UTLFResolver res)`
`<T extends UObject> List<T>`	`getObjectList(Class<T> clas, String key)`
`<T extends UObject> List<T>`	`getObjectList(Class<T> clas, String kn, UTLFResolver res)`
`<T extends UObject> List<T>`	`getObjectList(Class<T> clas, UPath path)`
`<T extends UObject> List<T>`	`getObjectList(Class<T> clas, UPath path, UTLFResolver res)`
`double`	`getReal(String kn, double dv)`
`double`	`getReal(String kn, double dv, UTLFResolver res)`
`double`	`getReal(UPath path, double dv)`
`double`	`getReal(UPath path, double dv, UTLFResolver res)`
`List<String>`	`getSortedKeyList()`
`String`	`getText(String kn, String dv)`
`String`	`getText(String kn, String dv, UTLFResolver res)`
`String`	`getText(UPath path, String dv)`
`String`	`getText(UPath path, String dv, UTLFResolver res)`
`boolean`	`hasNodeObject()`
`<T extends UObject> boolean`	`hasNodeObject(Class<T> clas)`
`void`	`initialize(Element e)`
`boolean`	`isDict()`
`boolean`	`isEmpty()`
`static boolean`	`isNullKey(String kn)`
`boolean`	`isSingleAndNullKeyed()`
`boolean`	`merge(UDict dict, boolean unique)` オブジェクトをマージする．下位のオブジェクトについてマージする．下位のUDictのマージにおいては，ノードオブジェクトが等しい場合のみ個々のマージの対象となり，それ以外は UArrayによるマージとなる．
`int`	`numberOfElements()` get Number of Elements under this objects.
`boolean`	`putNodeObject(String kn, UObject o)` Put Node Object.
`boolean`	`putNodeObject(UObject o)` Put Node Object.
`boolean`	`putNodeObject(UPath path, UObject o)` Put Node Object.
`boolean`	`putObject(String kn, UObject o)`
`boolean`	`putObject(UKey k, UObject o)`
`boolean`	`putObject(UPath path, UObject o)`
`boolean`	`putObjects(String kn, List<UObject> list)`
`void`	`removeAllObjects()` Remove All Object.
`UObject`	`removeNodeObject()` Remove Node Object.
`UObject`	`removeNodeObject(String kn)` Remove Node Object.
`UObject`	`removeNodeObject(UPath path)` Remove Node Object.
`UObject`	`removeObject(String kn)`
`UObject`	`removeObject(UPath path)`
`boolean`	`setSortedOutputByKey(boolean s)`
`void`	`shrinkNullKeyedDict()`
`int`	`size()`
`String`	`toString()`
`UArray`	`unDict()` Make Array of objects.

Methods inherited from class jp.ac.tokushima_u.db.utlf.content.UObject
asObject, compareTo, compareTo, getBoolean, getReal, isObject

Methods inherited from class jp.ac.tokushima_u.db.utlf.content.UInstance
asArray, asBoolean, asData, asDate, asFalse, asInteger, asKey, asNull, asReal, asReference, asString, asTrue, castBoolean, castInteger, castReal, castString, copyAttribute, createTop, duplicateInstance, equivalentAttributeTo, equivalentTextTo, getAttribute, getBasis, getScope, getSeeAlso, getText, hasValidText, isArray, isBoolean, isData, isDate, isFalse, isInteger, isKey, isNull, isReal, isReference, isString, isTrue, retrieveAttribute, setAttribute, setAttributes, setBasis, setScope, setSeeAlso, setText

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

Field Detail

EN
```
public static final String EN
```
See Also:

Constant Field Values

FQEN
```
public static final String FQEN
```

NKey
```
public static final String NKey
```
See Also:

Constant Field Values

Constructor Detail
- UDict
```
public UDict()
```

Method Detail

getEN
```
public String getEN()
```
Overrides:

getEN in class UInstance

getFQEN
```
public String getFQEN()
```
Overrides:

getFQEN in class UInstance

toString
```
public String toString()
```
Overrides:

toString in class UObject

isEmpty
```
public boolean isEmpty()
```

isDict
```
public boolean isDict()
```
Overrides:

isDict in class UInstance

asDict
```
public UDict asDict()
```
Overrides:

asDict in class UInstance

isNullKey

public static boolean isNullKey(String kn)

putObject

public boolean putObject(UKey k,
                         UObject o)

putObject

public boolean putObject(String kn,
                         UObject o)

putObject

public boolean putObject(UPath path,
                         UObject o)

putObjects

public boolean putObjects(String kn,
                          List<UObject> list)

removeObject

public UObject removeObject(String kn)

removeObject

public UObject removeObject(UPath path)

removeAllObjects
```
public void removeAllObjects()
```
Remove All Object.

addObject

public boolean addObject(String kn,
                         UObject o)

addObject

public boolean addObject(UPath path,
                         UObject o)

addObjects

public boolean addObjects(String kn,
                          List<UObject> list)

putNodeObject
```
public boolean putNodeObject(UObject o)
```
Put Node Object.

Parameters:

o - Object

Returns:

modified.

putNodeObject

public boolean putNodeObject(String kn,
                             UObject o)

Put Node Object.

Parameters:: kn - key; o - Object
Returns:: modified.

putNodeObject

public boolean putNodeObject(UPath path,
                             UObject o)

Put Node Object.

Parameters:: path - Path; o - Object
Returns:: modified.

removeNodeObject
```
public UObject removeNodeObject()
```
Remove Node Object.

Returns:

removed object.

removeNodeObject
```
public UObject removeNodeObject(String kn)
```
Remove Node Object.

Parameters:

kn - key

Returns:

removed object.

removeNodeObject
```
public UObject removeNodeObject(UPath path)
```
Remove Node Object.

Parameters:

path - Path

Returns:

removed object.

addNodeObject

public boolean addNodeObject(UObject o,
                             boolean unique)

Add Node Object.

Parameters:: o - Object; unique - keep uniqueness
Returns:: modified.

addNodeObject

public boolean addNodeObject(String kn,
                             UObject o,
                             boolean unique)

Add Node Object.

Parameters:: kn - key; o - Object; unique - keep uniqueness
Returns:: modified.

addNodeObject

public boolean addNodeObject(String kn,
                             UObject o)

Add Node Object.

Parameters:: kn - key; o - Object
Returns:: modified.

addNodeObject

public boolean addNodeObject(UPath path,
                             UObject o,
                             boolean unique)

Add Node Object.

Parameters:: path - Path; o - Object; unique - keep uniqueness
Returns:: modified.

addNodeObject

public boolean addNodeObject(UPath path,
                             UObject o)

Add Node Object.

Parameters:: path - Path; o - Object
Returns:: modified.

copyAllObjects
```
public void copyAllObjects(UDict d)
```
Copy Node Object.

Parameters:

d - source dict

duplicate
```
public UDict duplicate()
```
Duplicate Objects

Overrides:

duplicate in class UObject

Returns:

duplicated dict

create

public static UDict create(Element e)
                    throws UTLFException

Throws:: UTLFException

initialize

public void initialize(Element e)
                throws UTLFException

Specified by:: initialize in class UObject
Throws:: UTLFException

setSortedOutputByKey

public boolean setSortedOutputByKey(boolean s)

createElement

public Element createElement(Document doc)

Overrides:: createElement in class UObject

getKeySet
```
public Set<String> getKeySet()
```

getKeyList
```
public List<String> getKeyList()
```

getSortedKeyList

public List<String> getSortedKeyList()

getKey
```
public UKey getKey(String kn)
```

getObject

public <T extends UObject> T getObject(Class<T> clas,
                                       String kn)

getObject
```
public UObject getObject(String kn)
```

getObject

public <T extends UObject> T getObject(Class<T> clas,
                                       UPath path,
                                       UTLFResolver res)

getObject

public UObject getObject(UPath path,
                         UTLFResolver res)

getObject

public <T extends UObject> T getObject(Class<T> clas,
                                       UPath path)

getObject
```
public UObject getObject(UPath path)
```

hasNodeObject
```
public boolean hasNodeObject()
```

hasNodeObject

public <T extends UObject> boolean hasNodeObject(Class<T> clas)

getNodeObject

public <T extends UObject> T getNodeObject(Class<T> clas)

getNodeObject
```
public UObject getNodeObject()
```

getNodeObject

public <T extends UObject> T getNodeObject(Class<T> clas,
                                           String kn)

getNodeObject

public UObject getNodeObject(String kn)

getNodeObject

public <T extends UObject> T getNodeObject(Class<T> clas,
                                           UPath path,
                                           UTLFResolver res)

getNodeObject

public UObject getNodeObject(UPath path,
                             UTLFResolver res)

getNodeObject

public <T extends UObject> T getNodeObject(Class<T> clas,
                                           UPath path)

getNodeObject

public UObject getNodeObject(UPath path)

getObjectList

public <T extends UObject> List<T> getObjectList(Class<T> clas,
                                                 String kn,
                                                 UTLFResolver res)

getObjectList

public <T extends UObject> List<T> getObjectList(Class<T> clas,
                                                 String key)

getObjectList

public <T extends UObject> List<T> getObjectList(Class<T> clas,
                                                 UPath path,
                                                 UTLFResolver res)

getObjectList

public <T extends UObject> List<T> getObjectList(Class<T> clas,
                                                 UPath path)

getNodeObjectList

public <T extends UObject> List<T> getNodeObjectList(Class<T> clas,
                                                     String kn,
                                                     UTLFResolver res)

getNodeObjectList

public <T extends UObject> List<T> getNodeObjectList(Class<T> clas,
                                                     String key)

getNodeObjectList

public <T extends UObject> List<T> getNodeObjectList(Class<T> clas,
                                                     UPath path,
                                                     UTLFResolver res)

getNodeObjectList

public <T extends UObject> List<T> getNodeObjectList(Class<T> clas,
                                                     UPath path)

merge
```
public boolean merge(UDict dict,
                     boolean unique)
```
オブジェクトをマージする．下位のオブジェクトについてマージする．下位のUDictのマージにおいては，ノードオブジェクトが等しい場合のみ個々のマージの対象となり，それ以外は UArrayによるマージとなる．

Parameters:

dict - マージするオブジェクト．

unique - 同一オブジェクトは追加しない．

Returns:

success.

getDict

public UDict getDict(String kn,
                     UDict dv,
                     UTLFResolver res)

Retrieve sub dict.

Parameters:: kn - key name.; dv - default value.; res - UTLF resolver.
Returns:: dict

getDict

public UDict getDict(String kn,
                     UDict dv)

getDict
```
public UDict getDict(String kn)
```

getDict

public UDict getDict(String kn,
                     UTLFResolver res)

getDict

public UDict getDict(UPath path,
                     UDict dv,
                     UTLFResolver res)

Retrieve sub dict.

Parameters:: path - path to dict.; dv - default value.; res - UTLF repository resolver
Returns:: dict

getDict

public UDict getDict(UPath path,
                     UDict dv)

getDict

public UDict getDict(UPath path,
                     UTLFResolver res)

getDict
```
public UDict getDict(UPath path)
```

getDate

public UDate getDate(UPath path,
                     UDate dv,
                     UTLFResolver res)

Parameters:: path - path to real.; dv - default value.; res - resolver.
Returns:: date

getDate

public UDate getDate(UPath path,
                     UDate dv)

getDate

public UDate getDate(String kn,
                     UDate dv,
                     UTLFResolver res)

getDate

public UDate getDate(String kn,
                     UDate dv)

getText

public String getText(UPath path,
                      String dv,
                      UTLFResolver res)

Parameters:: path - path to text.; dv - default value.; res - resolver.
Returns:: text value

getText

public String getText(UPath path,
                      String dv)

getText

public String getText(String kn,
                      String dv,
                      UTLFResolver res)

getText

public String getText(String kn,
                      String dv)

getInteger

public long getInteger(UPath path,
                       long dv,
                       UTLFResolver res)
                throws UTLFException

Parameters:: path - path to integer.; dv - default value.; res - resolver.
Returns:: integer value
Throws:: UTLFException - UTLF処理上に何らかのエラーがある場合．

getInteger

public long getInteger(UPath path,
                       long dv)
                throws UTLFException

Throws:: UTLFException

getInteger

public long getInteger(String kn,
                       long dv,
                       UTLFResolver res)
                throws UTLFException

Throws:: UTLFException

getInteger

public long getInteger(String kn,
                       long dv)
                throws UTLFException

Throws:: UTLFException

getReal

public double getReal(UPath path,
                      double dv,
                      UTLFResolver res)
               throws UTLFException

Parameters:: path - path to real.; dv - default value.; res - resolver.
Returns:: double value
Throws:: UTLFException - UTLF処理上に何らかのエラーがある場合．

getReal

public double getReal(UPath path,
                      double dv)
               throws UTLFException

Throws:: UTLFException

getReal

public double getReal(String kn,
                      double dv,
                      UTLFResolver res)
               throws UTLFException

Throws:: UTLFException

getReal

public double getReal(String kn,
                      double dv)
               throws UTLFException

Throws:: UTLFException

getBoolean

public boolean getBoolean(UPath path,
                          boolean dv,
                          UTLFResolver res)
                   throws UTLFException

Parameters:: path - path to boolean.; dv - default value.; res - resolver.
Returns:: boolean value
Throws:: UTLFException - Exception

getBoolean

public boolean getBoolean(UPath path,
                          boolean dv)
                   throws UTLFException

Throws:: UTLFException

getBoolean

public boolean getBoolean(String kn,
                          boolean dv,
                          UTLFResolver res)
                   throws UTLFException

Throws:: UTLFException

getBoolean

public boolean getBoolean(String kn,
                          boolean dv)
                   throws UTLFException

Throws:: UTLFException

size
```
public int size()
```

isSingleAndNullKeyed
```
public boolean isSingleAndNullKeyed()
```

shrinkNullKeyedDict
```
public void shrinkNullKeyedDict()
```

equivalentTo
```
public boolean equivalentTo(UDict o)
```

equivalentTo
```
public boolean equivalentTo(UObject o)
```
Overrides:

equivalentTo in class UObject

equivalentTo
```
public boolean equivalentTo(Object o)
```
Overrides:

equivalentTo in class UObject

unDict
```
public UArray unDict()
```
Make Array of objects.

Returns:

a UArray object contains all objects of this dict.

countObjects
```
public UDict countObjects(UDict cdict)
                   throws UTLFException
```
Count Number of Objects.

Parameters:

cdict - dict for count

Returns:

dict include counted information. (cdict)

Throws:

UTLFException - UTLF処理上に何らかのエラーがある場合．

countObjects
```
public UDict countObjects()
                   throws UTLFException
```
Count Number of Objects.

Returns:

dict include counted information.

Throws:

UTLFException - UTLF処理上に何らかのエラーがある場合．

numberOfElements
```
public int numberOfElements()
```
get Number of Elements under this objects.

Overrides:

numberOfElements in class UInstance

Returns:

number of elements

Class UDict

Field Summary

Fields inherited from class jp.ac.tokushima_u.db.utlf.content.UInstance

Constructor Summary

Method Summary

Methods inherited from class jp.ac.tokushima_u.db.utlf.content.UObject

Methods inherited from class jp.ac.tokushima_u.db.utlf.content.UInstance

Methods inherited from class java.lang.Object

Field Detail

EN

FQEN

NKey

Constructor Detail

UDict

Method Detail

getEN

getFQEN

toString

isEmpty

isDict

asDict

isNullKey

putObject

putObject

putObject

putObjects

removeObject

removeObject

removeAllObjects

addObject

addObject

addObjects

putNodeObject

putNodeObject

putNodeObject

removeNodeObject

removeNodeObject

removeNodeObject

addNodeObject

addNodeObject

addNodeObject

addNodeObject

addNodeObject

copyAllObjects

duplicate

create

initialize

setSortedOutputByKey

createElement

getKeySet

getKeyList

getSortedKeyList

getKey

getObject

getObject

getObject

getObject

getObject

getObject

hasNodeObject

hasNodeObject

getNodeObject

getNodeObject

getNodeObject

getNodeObject

getNodeObject

getNodeObject

getNodeObject

getNodeObject

getObjectList

getObjectList

getObjectList

getObjectList

getNodeObjectList

getNodeObjectList

getNodeObjectList

getNodeObjectList

merge

getDict

getDict