Package org.biojava.bio.program.tagvalue
Class Index2Model
java.lang.Object
org.biojava.bio.program.tagvalue.Index2Model
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addKeyPath
(String keyName, Object[] path) Add a key and a path to that key in the tag-value hierachy.Object[]
getKeyPath
(String keyName) getKeys()
Retrieve the tag currently used as primary key.void
removeKeyPath
(String keyName) Remove a key.void
setPrimaryKeyName
(String primaryKeyName) Set the tag to use as a primary key in the index.
-
Constructor Details
-
Index2Model
public Index2Model()
-
-
Method Details
-
setPrimaryKeyName
Set the tag to use as a primary key in the index.
Whenever a value for the primary key tag is seen, this is passed to the indexer as the primary key for indexing.
Primary keys must be unique between entries, and each entry must provide exactly one primary key value.
- Parameters:
primaryKeyName
- the tag to use as primary key
-
getPrimaryKeyName
Retrieve the tag currently used as primary key.- Returns:
- a String representing the primary key name
-
addKeyPath
Add a key and a path to that key in the tag-value hierachy.
Secondary keys are potentialy non-unique properties of the entries being indexed. Multiple records can use the same secondary key values, and a single record can have multiple values for a secondary key. However, the primary key must be unique.
- Parameters:
keyName
- the name of the secondary key to addpath
- the names of each tag to follow to reach the value of the key
-
removeKeyPath
Remove a key.- Parameters:
keyName
- the name of the key to remove
-
getKeyPath
-
getKeys
-