---

TreeKeyIdx Class Reference

Class VerseKey The SWKey implementation used for verse based modules like Bibles or commentaries. More...

#include <treekeyidx.h>

Inheritance diagram for TreeKeyIdx:

[legend]Collaboration diagram for TreeKeyIdx:

[legend]List of all members.

Public Methods
	TreeKeyIdx (const TreeKeyIdx &ikey)
	TreeKeyIdx (const char *idxPath, int fileMode=-1)
	~TreeKeyIdx ()
virtual const char *	getLocalName ()
virtual const char *	setLocalName (const char *)
virtual const char *	getUserData (int *size=0)
virtual void	setUserData (const char *userData, int size=0)
virtual const char *	getFullName () const
virtual void	root ()
virtual bool	parent ()
virtual bool	firstChild ()
virtual bool	nextSibling ()
virtual bool	previousSibling ()
virtual bool	hasChildren ()
virtual void	append ()
virtual void	appendChild ()
virtual void	insertBefore ()
virtual void	remove ()
virtual void	save ()
virtual void	copyFrom (const TreeKeyIdx &ikey)
virtual void	copyFrom (const SWKey &ikey)
	Equates this SWKey to another SWKey object. More...
virtual SWKey &	operator= (const TreeKeyIdx &ikey)
void	setOffset (unsigned long offset)
unsigned long	getOffset () const
virtual SWKEY_OPERATORS void	setText (const char *ikey)
	Equates this SWKey to a character string. More...
virtual void	setPosition (SW_POSITION p)
virtual const char *	getText () const
	returns text key if (char *) cast is requested.
virtual int	_compare (const TreeKeyIdx &ikey)
virtual int	compare (const SWKey &ikey)
	Compares another VerseKey object. More...
virtual void	decrement (int steps=1)
	Decrements key a number of entries. More...
virtual void	increment (int steps=1)
	Increments key a number of entries. More...
virtual char	Traversable ()
Static Public Methods
signed char	create (const char *path)
Private Methods
void	getTreeNodeFromDatOffset (long ioffset, TreeNode *buf) const
char	getTreeNodeFromIdxOffset (long ioffset, TreeNode *node) const
void	saveTreeNode (TreeNode *node)
void	saveTreeNodeOffsets (TreeNode *node)
void	init ()
Private Attributes
TreeKeyIdx::TreeNode	currentNode
char *	path
FileDesc *	idxfd
FileDesc *	datfd
Static Private Attributes
SWClass	classdef

---

Detailed Description

Class VerseKey The SWKey implementation used for verse based modules like Bibles or commentaries.

Definition at line 35 of file treekeyidx.h.

---

Member Function Documentation

int TreeKeyIdx::compare (  const SWKey &    ikey )  [virtual]

Compares another VerseKey object. Parameters: ikey  key to compare with this one Returns: >0 if this key is greater than compare key; <0 if this key is smaller than compare key; 0 if the keys are the same Implements TreeKey. Definition at line 520 of file treekeyidx.cpp. References SWKey::compare(). { TreeKeyIdx *treeKey = SWDYNAMIC_CAST(TreeKeyIdx, (&ikey)); if (treeKey) return _compare(*treeKey); return SWKey::compare(ikey); }

void TreeKeyIdx::copyFrom (  const SWKey &    ikey )  [virtual]

Equates this SWKey to another SWKey object. Parameters: ikey  other swkey object Reimplemented from SWKey. Definition at line 494 of file treekeyidx.cpp. References SWKey::copyFrom(). { SWKey::copyFrom(ikey); }

void TreeKeyIdx::decrement (  int    steps = 1 )  [virtual]

Decrements key a number of entries. Parameters: steps  Number of entries to jump backward Returns: *this Implements TreeKey. Definition at line 528 of file treekeyidx.cpp. { error = getTreeNodeFromIdxOffset(currentNode.offset - (4*steps), &currentNode); }

void TreeKeyIdx::increment (  int    steps = 1 )  [virtual]

Increments key a number of entries. Parameters: increment  Number of entries to jump forward Returns: *this Implements TreeKey. Definition at line 532 of file treekeyidx.cpp. { error = getTreeNodeFromIdxOffset(currentNode.offset + (4*steps), &currentNode); /* // assert positive if (steps < 0) { decrement(steps * -1); return; } while (steps > 0) { if (!firstChild()) { if (!nextSibbling() { error = KEYERR_OUTOFBOUNDS; return; } } steps--; } */ }

void TreeKeyIdx::setText (  const char *    ikey )  [virtual]

Equates this SWKey to a character string. Parameters: ikey  string to set this key to Implements TreeKey. Definition at line 466 of file treekeyidx.cpp. References SWKey::Error(). { char *buf = 0; stdstr(&buf, ikey); char *leaf = strtok(buf, "/"); root(); while ((leaf) && (!Error())) { bool ok, inChild = false; for (ok = firstChild(); ok; ok = nextSibling()) { inChild = true; if (!stricmp(leaf, getLocalName())) break; } leaf = strtok(0, "/"); if (!ok) { if (inChild) { // if we didn't find a matching child node, default to first child parent(); firstChild(); } if (leaf) error = KEYERR_OUTOFBOUNDS; break; } } delete [] buf; }

---

The documentation for this class was generated from the following files:

• treekeyidx.h
• treekeyidx.cpp

---