de.innovationgate.webgate.api

Class WGContentKey

java.lang.Object

de.innovationgate.webgate.api.WGContentKey

public class WGContentKey
extends java.lang.Object

Represents the complete unique key of a content document, consisting of the struct key of the connected struct entry, the language code and the content version.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TOKEN_DIVIDER

Constructor Summary

Constructors

Constructor and Description
WGContentKey(java.lang.Object structKey, java.lang.String strLanguage, int iVersion) Constructor for content key object.

Method Summary

Methods

Modifier and Type	Method and Description
static WGContentKey	create(WGContent content) Creates a new content key object, representing the unique content key of the parameter content.
static WGContentKey	create(WGContent content, boolean unique) Creates a new content key object, representing the content key of the parameter content.
static WGContentKey	create(WGDocumentCore doc) Creates a new content key object, representing the unique content key of the parameter content core.
static WGContentKey	create(WGDocumentCore doc, boolean unique) Creates a new content key object, representing the content key of the parameter content core.
boolean	equals(java.lang.Object arg0)
java.lang.String	getLanguage() Returns the language name part of this content key.
java.lang.Object	getStructKey() Returns the struct key part of this key.
int	getVersion() Returns the version number part of the key.
int	hashCode()
boolean	isValid() Tests, if this is structurally a valid content key
static WGContentKey	parse(java.lang.String key, WGDatabase db) Parses a content key string and returns the according unique content key object.
static WGContentKey	parse(java.lang.String key, WGDatabase db, boolean unique) Parses a content key string and returns the according content key object.
WGDocumentKey	toDocumentKey() Creates a document key pendant for this content key
java.lang.String	toString() Returns a string representation for this content key, as used in URLs and parsed by the parse methods on this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

TOKEN_DIVIDER

public static final java.lang.String TOKEN_DIVIDER

See Also:

Constant Field Values

Constructor Detail

WGContentKey

public WGContentKey(java.lang.Object structKey,
            java.lang.String strLanguage,
            int iVersion)

Constructor for content key object. Takes all parts of it as parameter.

Parameters:

structKey - The struct key

strLanguage - The language name

iVersion - The content version

Method Detail

isValid

public boolean isValid()

Tests, if this is structurally a valid content key

parse

public static WGContentKey parse(java.lang.String key,
                 WGDatabase db,
                 boolean unique)
                          throws WGAPIException

Parses a content key string and returns the according content key object. The database, whose content is meant needs to be provided to parse the struct key part. If the database is ommitted the struct key will be left in it's string representation.. An additional parameter determines, if the unique mode key or the URL mode key is to be created.

Parameters:

key - Content key string representation

db - Content database, whose content is adressed by the content key. Omit to keep struct key in its string representation.

unique - When true, creates unique content key (always use real version), else creates url mode key (if content is released, 0 is taken for version)

Returns:

WGContentKey

Throws:

WGAPIException

parse

public static WGContentKey parse(java.lang.String key,
                 WGDatabase db)
                          throws WGAPIException

Parses a content key string and returns the according unique content key object. The database that the content key belongs to needs to be provided to parse the struct key part to its native data format If the database is ommitted the struct key will be left in it's string representation..

Parameters:

key - Content key string representation

db - Content database, whose content is adressed by the content key. Omit to keep struct key in its string representation.

Returns:

WGContentKey

Throws:

WGAPIException

create

public static WGContentKey create(WGContent content,
                  boolean unique)
                           throws WGAPIException

Creates a new content key object, representing the content key of the parameter content. An additional parameter determines, if the unique mode key or the URL mode key is to be created.

Parameters:

content - The content, whose content key should be built

unique - When true, creates unique content key (always use real version), else creates url mode key (if content is released, 0 is taken for version)

Returns:

WGContentKey

Throws:

WGAPIException

create

public static WGContentKey create(WGContent content)
                           throws WGAPIException

Creates a new content key object, representing the unique content key of the parameter content.

Parameters:

content - The content, whose content key should be built

Returns:

WGContentKey

Throws:

WGAPIException

create

public static WGContentKey create(WGDocumentCore doc,
                  boolean unique)
                           throws WGAPIException

Creates a new content key object, representing the content key of the parameter content core. An additional parameter determines, if the unique mode key or the URL mode key is to be created.

Parameters:

doc - The content core, whose content key should be built

unique - When true, creates unique content key (always use real version), else creates url mode key (if content is released, 0 is taken for version)

Returns:

WGContentKey

Throws:

WGAPIException

create

public static WGContentKey create(WGDocumentCore doc)
                           throws WGAPIException

Creates a new content key object, representing the unique content key of the parameter content core.

Parameters:

doc - content document core, whose content key should be built.

Returns:

WGContentKey

Throws:

WGAPIException

getVersion

public int getVersion()

Returns the version number part of the key.

Returns:

int

getLanguage

public java.lang.String getLanguage()

Returns the language name part of this content key.

Returns:

Returns a String

getStructKey

public java.lang.Object getStructKey()

Returns the struct key part of this key.

Returns:

Object

toString

public java.lang.String toString()

Returns a string representation for this content key, as used in URLs and parsed by the parse methods on this object.

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object arg0)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toDocumentKey

public WGDocumentKey toDocumentKey()

Creates a document key pendant for this content key