SWKey Class Reference

#include <swkey.h>

Inheritance diagram for SWKey:

Collaboration diagram for SWKey:

Classes
class	LocaleCache

Public Member Functions
virtual void	clearBounds () const
virtual SWKey *	clone () const
virtual int	compare (const SWKey &ikey)
virtual void	copyFrom (const SWKey &ikey)
virtual void	decrement (int steps=1)
virtual bool	equals (const SWKey &ikey)
SWDEPRECATED char	Error ()
const SWClass *	getClass () const
virtual char	getError () const
virtual long	getIndex () const
char *	getLocale () const
virtual const char *	getOSISRefRangeText () const
virtual const char *	getRangeText () const
virtual const char *	getShortRangeText () const
virtual const char *	getShortText () const
virtual const char *	getText () const
virtual void	increment (int steps=1)
virtual bool	isBoundSet () const
bool	isPersist () const
virtual bool	isTraversable () const
SWDEPRECATED char	Persist () const
SWDEPRECATED char	Persist (signed char ipersist)
virtual char	popError ()
virtual void	positionFrom (const SWKey &ikey)
virtual void	setError (char err)
virtual void	setIndex (long iindex)
void	setLocale (const char *name)
void	setPersist (bool ipersist)
virtual void	setPosition (SW_POSITION)
virtual void	setText (const char *ikey)
	SWKey (const char *ikey=0)
	SWKey (const SWKey &k)
virtual	~SWKey ()

Public Attributes
SW_u64	userData

Protected Member Functions
SWLocale *	getPrivateLocale () const

Protected Attributes
bool	boundSet
char	error
char *	keytext
char *	localeName
const SWClass *	myClass
bool	persist
char *	rangeText

Private Member Functions
void	init ()

Private Attributes
long	index
SWLocale *	locale

Static Private Attributes
static LocaleCache	localeCache

Detailed Description

SWKey is used for positioning an SWModule to a specific entry. It always represents a possible location into a module and can additionally represent a domain of entries (e.g. "John 3:16" in the domain "John 1:1 - Mark 5:25")

Definition at line 77 of file swkey.h.

Constructor & Destructor Documentation

SWKey::SWKey

(

const char *

ikey = 0

)

initializes instance of SWKey from a string All keys can be reduced to a string representation which should be able to be used to again set the key to the same position

Parameters

ikey	string to use for initializing this new key

Definition at line 43 of file swkey.cpp.

                             : SWObject(classdef)
{
    init();
    index     = 0;
    persist   = 0;
    keytext   = 0;
    rangeText = 0;
    error     = 0;
    userData  = 0;
    stdstr(&keytext, ikey);
}

SWKey::SWKey

(

const SWKey &

k

)

Copy Constructor

Parameters

k	The SWKey object to copy.

Definition at line 55 of file swkey.cpp.

                           : SWObject(classdef)
{
    init();
    stdstr(&localeName, k.localeName);
    index     = k.index;
    persist   = k.persist;
    userData  = k.userData;
    keytext   = 0;
    rangeText = 0;
    error     = k.error;
    setText(k.getText());
}

SWKey::~SWKey ( )

virtual

Destructor, cleans up this instance of SWKey

Definition at line 84 of file swkey.cpp.

              {
    delete [] keytext;
    delete [] rangeText;
    delete [] localeName;
}

Member Function Documentation

virtual void SWKey::clearBounds ( ) const

inlinevirtual

Reimplemented in VerseKey.

Definition at line 190 of file swkey.h.

{ boundSet = false; }

SWKey * SWKey::clone ( ) const

virtual

Returns a new exact clone of this SWKey object. This allocates a new SWKey which must be deleted by the caller

Returns

new clone of this key

Reimplemented in VerseKey, VerseTreeKey, TreeKeyIdx, and ListKey.

Definition at line 75 of file swkey.cpp.

{
    return new SWKey(*this);
}

int SWKey::compare ( const SWKey &  ikey )

virtual

Compares this key object to another SWKey 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

Reimplemented in VerseKey, TreeKey, and TreeKeyIdx.

Definition at line 218 of file swkey.cpp.

{
    return strcmp((const char *)*this, (const char *)ikey);
}

void SWKey::copyFrom ( const SWKey &  ikey )

virtual

Copies as much info (position, range, etc.) as possible from another SWKey object

Parameters

ikey	other SWKey object from which to copy

Reimplemented in VerseKey, ListKey, and TreeKeyIdx.

Definition at line 173 of file swkey.cpp.

                                      {
// not desirable    Persist(ikey.Persist());
    setLocale(ikey.getLocale());
    setText((const char *)ikey);
}

void SWKey::decrement ( int  steps = 1 )

virtual

Decrements key a number of entry positions This is only valid if isTraversable is true

Parameters

steps

Number of entries to jump backward

Reimplemented in VerseKey, ListKey, TreeKey, TreeKeyIdx, and VerseTreeKey.

Definition at line 261 of file swkey.cpp.

                         {
    error = KEYERR_OUTOFBOUNDS;
}

virtual bool SWKey::equals ( const SWKey &  ikey )

inlinevirtual

test equality of this SWKey object's position with another SWKey

Parameters

ikey	key to compare with this one

Returns

true if the key positions are equal

Definition at line 204 of file swkey.h.

{ return !compare(ikey); }

SWDEPRECATED char SWKey::Error ( )

inline

Deprecated:

Use popError and getError instead

Definition at line 169 of file swkey.h.

{ return popError(); }

const SWClass* SWObject::getClass ( ) const

inlineinherited

Use this to get the class definition and inheritance order.

Returns

The class definition of this object

Definition at line 63 of file swobject.h.

                                    {
        return myClass;
    }

virtual char SWKey::getError ( ) const

inlinevirtual

Definition at line 164 of file swkey.h.

{ return error; }

virtual long SWKey::getIndex ( ) const

inlinevirtual

Use this function to get an index position within a module.

Reimplemented in VerseKey, ListKey, and TreeKey.

Definition at line 229 of file swkey.h.

{ return index; }

char* SWKey::getLocale ( ) const

inline

Definition at line 224 of file swkey.h.

{ return localeName; }

const char * SWKey::getOSISRefRangeText ( ) const

virtual

Reimplemented in VerseKey, and ListKey.

Definition at line 203 of file swkey.cpp.

                                             {
    return getRangeText();
}

SWLocale * SWKey::getPrivateLocale ( ) const

protected

Definition at line 111 of file swkey.cpp.

                                        {
    if (!locale) {
        if ((!localeCache.name) || (strcmp(localeCache.name, localeName))) {
            stdstr(&(localeCache.name), localeName);
            // this line is the entire bit of work we're trying to avoid with the cache
            // worth it?  compare time examples/cmdline/search KJV "God love world" to
            // same with this method reduced to:
            // if (!local) local = ... (call below); return locale;
            localeCache.locale = LocaleMgr::getSystemLocaleMgr()->getLocale(localeName);
        }
        locale = localeCache.locale;
    }
    return locale;
}

const char * SWKey::getRangeText ( ) const

virtual

Reimplemented in VerseKey, and ListKey.

Definition at line 193 of file swkey.cpp.

                                      {
    stdstr(&rangeText, keytext);
    return rangeText;
}

virtual const char* SWKey::getShortRangeText ( ) const

inlinevirtual

Reimplemented in VerseKey, and ListKey.

Definition at line 187 of file swkey.h.

{ return getRangeText(); }

virtual const char* SWKey::getShortText ( ) const

inlinevirtual

Reimplemented in VerseKey, and ListKey.

Definition at line 185 of file swkey.h.

{ return getText(); }

const char * SWKey::getText ( ) const

virtual

returns string representation of this key

Reimplemented in VerseKey, ListKey, TreeKey, and TreeKeyIdx.

Definition at line 184 of file swkey.cpp.

                                 {
    return keytext;
}

void SWKey::increment ( int  steps = 1 )

virtual

Increments key a number of entry positions This is only valid if isTraversable is true

Parameters

steps

Number of entries to jump forward

Reimplemented in VerseKey, ListKey, TreeKey, TreeKeyIdx, and VerseTreeKey.

Definition at line 248 of file swkey.cpp.

                         {
    error = KEYERR_OUTOFBOUNDS;
}

void SWKey::init ( )

private

Definition at line 68 of file swkey.cpp.

                 {
    boundSet = false;
    locale = 0;
    localeName = 0;
    setLocale(LocaleMgr::getSystemLocaleMgr()->getDefaultLocaleName());
}

virtual bool SWKey::isBoundSet ( ) const

inlinevirtual

Definition at line 189 of file swkey.h.

{ return boundSet; }

bool SWKey::isPersist

(

)

const

Gets whether this key should persist in any module to which it is set otherwise just a copy will be used in the module.

Returns

1 - persists in module; 0 - a copy is attempted

Definition at line 99 of file swkey.cpp.

{
    return persist;
}

virtual bool SWKey::isTraversable ( ) const

inlinevirtual

Whether or not this key can be ++ – incremented

Reimplemented in VerseKey, ListKey, TreeKey, TreeKeyIdx, and VerseTreeKey.

Definition at line 222 of file swkey.h.

{ return false; }

SWDEPRECATED char SWKey::Persist ( ) const

inline

Deprecated:

Use isPersist

Definition at line 148 of file swkey.h.

{ return isPersist(); }

SWDEPRECATED char SWKey::Persist ( signed char  ipersist )

inline

Deprecated:

Use setPersist and isPersist instead.

Definition at line 158 of file swkey.h.

{ setPersist(ipersist!=0); return isPersist(); }

char SWKey::popError ( )

virtual

Gets and clears error status

Returns

error status

Definition at line 147 of file swkey.cpp.

{
    char retval = error;

    error = 0;
    return retval;
}

virtual void SWKey::positionFrom ( const SWKey &  ikey )

inlinevirtual

Reimplemented in VerseKey.

Definition at line 180 of file swkey.h.

{ copyFrom(ikey); }

virtual void SWKey::setError ( char  err )

inlinevirtual

Definition at line 165 of file swkey.h.

{ error = err; }

virtual void SWKey::setIndex ( long  iindex )

inlinevirtual

See documentation for Index()

Reimplemented in VerseKey, ListKey, and TreeKey.

Definition at line 233 of file swkey.h.

{ index = iindex; }

void SWKey::setLocale ( const char *  name )

inline

Definition at line 225 of file swkey.h.

{ stdstr(&localeName, name); locale = 0;    } // this will force an on demand lookup of our locale

void SWKey::setPersist

(

bool

ipersist

)

Sets whether this key should persist in any module to which it is set otherwise just a copy will be used in the module.

Parameters

ipersist

value which to set persist;

Definition at line 135 of file swkey.cpp.

{
    persist = ipersist;
}

void SWKey::setPosition ( SW_POSITION  p )

virtual

Reimplemented in VerseKey, ListKey, TreeKey, VerseTreeKey, and TreeKeyIdx.

Definition at line 228 of file swkey.cpp.

                                     {
    switch (p) {
    case POS_TOP:
//      *this = "";
        break;
    case POS_BOTTOM:
//      *this = "zzzzzzzzz";
        break;
    } 
}

void SWKey::setText ( const char *  ikey )

virtual

Sets this SWKey with a character string

Parameters

ikey	string used to set this key

Reimplemented in VerseKey, ListKey, TreeKey, and TreeKeyIdx.

Definition at line 162 of file swkey.cpp.

                                    {
    stdstr(&keytext, ikey);
}

Member Data Documentation

bool SWKey::boundSet

mutableprotected

Definition at line 104 of file swkey.h.

char SWKey::error

mutableprotected

Definition at line 106 of file swkey.h.

long SWKey::index

private

Definition at line 97 of file swkey.h.

char* SWKey::keytext

protected

Definition at line 102 of file swkey.h.

SWLocale* SWKey::locale

mutableprivate

Definition at line 94 of file swkey.h.

SWKey::LocaleCache SWKey::localeCache

staticprivate

Definition at line 92 of file swkey.h.

char* SWKey::localeName

protected

Definition at line 108 of file swkey.h.

const SWClass* SWObject::myClass

protectedinherited

Definition at line 55 of file swobject.h.

bool SWKey::persist

protected

Definition at line 105 of file swkey.h.

char* SWKey::rangeText

mutableprotected

Definition at line 103 of file swkey.h.

SW_u64 SWKey::userData

Definition at line 115 of file swkey.h.

---

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

• include/swkey.h
• src/keys/swkey.cpp