org.apache.jackrabbit.core
Class ItemImpl

java.lang.Object
  org.apache.jackrabbit.core.ItemImpl

All Implemented Interfaces:

javax.jcr.Item

Direct Known Subclasses:

NodeImpl, PropertyImpl

public abstract class ItemImpl
extends java.lang.Object
implements javax.jcr.Item

ItemImpl implements the Item interface.

Field Summary

protected ItemData	data Item data associated with this item.
protected ItemId	id
protected ItemManager	itemMgr ItemManager that created this Item
protected RepositoryImpl	rep the Repository object
protected SessionImpl	session Session through which this Item was acquired
protected SessionItemStateManager	stateMgr SessionItemStateManager associated with this Item
protected static int	STATUS_DESTROYED
protected static int	STATUS_INVALIDATED
protected static int	STATUS_MODIFIED
protected static int	STATUS_NORMAL

Method Summary

abstract void	accept(javax.jcr.ItemVisitor visitor)
javax.jcr.Item	getAncestor(int degree)
int	getDepth()
ItemId	getId() Return the id of this Item.
abstract java.lang.String	getName()
protected abstract ItemState	getOrCreateTransientItemState()
abstract javax.jcr.Node	getParent()
java.lang.String	getPath()
Path	getPrimaryPath() Returns the primary path to this Item.
abstract Name	getQName() Same as Item.getName() except that this method returns a Name instead of a String.
javax.jcr.Session	getSession() Returns the session associated with this item.
protected void	internalRemove(boolean noChecks) Same as Item.remove() except for the noChecks parameter.
boolean	isModified()
boolean	isNew()
abstract boolean	isNode()
boolean	isSame(javax.jcr.Item otherItem)
protected boolean	isTransactionalNew() checks if this item is new.
protected boolean	isTransient()
protected abstract void	makePersistent()
void	refresh(boolean keepChanges)
void	remove()
java.lang.String	safeGetJCRPath() Failsafe mapping of internal id to JCR path for use in diagnostic output, error messages etc.
protected void	sanityCheck() Performs a sanity check on this item and the associated session.
void	save()
protected void	setRemoved() Marks this instance as 'removed' and notifies its listeners.
java.lang.String	toString() Returns the(safe) path of this item for use in diagnostic output.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STATUS_NORMAL

protected static final int STATUS_NORMAL

See Also:

Constant Field Values

STATUS_MODIFIED

protected static final int STATUS_MODIFIED

See Also:

Constant Field Values

STATUS_DESTROYED

protected static final int STATUS_DESTROYED

See Also:

Constant Field Values

STATUS_INVALIDATED

protected static final int STATUS_INVALIDATED

See Also:

Constant Field Values

id

protected final ItemId id

session

protected final SessionImpl session

Session through which this Item was acquired

rep

protected final RepositoryImpl rep

the Repository object

data

protected final ItemData data

Item data associated with this item.

itemMgr

protected final ItemManager itemMgr

ItemManager that created this Item

stateMgr

protected final SessionItemStateManager stateMgr

SessionItemStateManager associated with this Item

Method Detail

sanityCheck

protected void sanityCheck()
                    throws javax.jcr.RepositoryException

Performs a sanity check on this item and the associated session.

Throws:

javax.jcr.RepositoryException - if this item has been rendered invalid for some reason

isTransient

protected boolean isTransient()

getOrCreateTransientItemState

protected abstract ItemState getOrCreateTransientItemState()
                                                    throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

makePersistent

protected abstract void makePersistent()
                                throws javax.jcr.InvalidItemStateException

Throws:

javax.jcr.InvalidItemStateException

setRemoved

protected void setRemoved()
                   throws javax.jcr.RepositoryException

Marks this instance as 'removed' and notifies its listeners. The resulting state is either 'temporarily invalidated' or 'permanently invalidated', depending on the initial state.

Throws:

javax.jcr.RepositoryException - if an error occurs

getId

public ItemId getId()

Return the id of this Item.

Returns:

the id of this Item

getPrimaryPath

public Path getPrimaryPath()
                    throws javax.jcr.RepositoryException

Returns the primary path to this Item.

Returns:

the primary path to this Item

Throws:

javax.jcr.RepositoryException

safeGetJCRPath

public java.lang.String safeGetJCRPath()

Failsafe mapping of internal id to JCR path for use in diagnostic output, error messages etc.

Returns:

JCR path or some fallback value

internalRemove

protected void internalRemove(boolean noChecks)
                       throws javax.jcr.version.VersionException,
                              javax.jcr.lock.LockException,
                              javax.jcr.nodetype.ConstraintViolationException,
                              javax.jcr.RepositoryException

Same as Item.remove() except for the noChecks parameter.

Parameters:

noChecks -

Throws:

javax.jcr.version.VersionException

javax.jcr.lock.LockException

javax.jcr.RepositoryException

javax.jcr.nodetype.ConstraintViolationException

getQName

public abstract Name getQName()
                       throws javax.jcr.RepositoryException

Same as Item.getName() except that this method returns a Name instead of a String.

Returns:

the name of this item as Name

Throws:

javax.jcr.RepositoryException - if an error occurs.

accept

public abstract void accept(javax.jcr.ItemVisitor visitor)
                     throws javax.jcr.RepositoryException

Specified by:

accept in interface javax.jcr.Item

Throws:

javax.jcr.RepositoryException

isNode

public abstract boolean isNode()

Specified by:

isNode in interface javax.jcr.Item

getName

public abstract java.lang.String getName()
                                  throws javax.jcr.RepositoryException

Specified by:

getName in interface javax.jcr.Item

Throws:

javax.jcr.RepositoryException

getParent

public abstract javax.jcr.Node getParent()
                                  throws javax.jcr.ItemNotFoundException,
                                         javax.jcr.AccessDeniedException,
                                         javax.jcr.RepositoryException

Specified by:

getParent in interface javax.jcr.Item

Throws:

javax.jcr.ItemNotFoundException

javax.jcr.AccessDeniedException

javax.jcr.RepositoryException

isNew

public boolean isNew()

Specified by:

isNew in interface javax.jcr.Item

isTransactionalNew

protected boolean isTransactionalNew()

checks if this item is new. running outside of transactions, this is the same as isNew() but within a transaction an item can be saved but not yet persisted.

isModified

public boolean isModified()

Specified by:

isModified in interface javax.jcr.Item

remove

public void remove()
            throws javax.jcr.version.VersionException,
                   javax.jcr.lock.LockException,
                   javax.jcr.nodetype.ConstraintViolationException,
                   javax.jcr.RepositoryException

Specified by:

remove in interface javax.jcr.Item

Throws:

javax.jcr.version.VersionException

javax.jcr.lock.LockException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.RepositoryException

save

public void save()
          throws javax.jcr.AccessDeniedException,
                 javax.jcr.ItemExistsException,
                 javax.jcr.nodetype.ConstraintViolationException,
                 javax.jcr.InvalidItemStateException,
                 javax.jcr.ReferentialIntegrityException,
                 javax.jcr.version.VersionException,
                 javax.jcr.lock.LockException,
                 javax.jcr.nodetype.NoSuchNodeTypeException,
                 javax.jcr.RepositoryException

Specified by:

save in interface javax.jcr.Item

Throws:

javax.jcr.AccessDeniedException

javax.jcr.ItemExistsException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.InvalidItemStateException

javax.jcr.ReferentialIntegrityException

javax.jcr.version.VersionException

javax.jcr.lock.LockException

javax.jcr.nodetype.NoSuchNodeTypeException

javax.jcr.RepositoryException

refresh

public void refresh(boolean keepChanges)
             throws javax.jcr.InvalidItemStateException,
                    javax.jcr.RepositoryException

Specified by:

refresh in interface javax.jcr.Item

Throws:

javax.jcr.InvalidItemStateException

javax.jcr.RepositoryException

getAncestor

public javax.jcr.Item getAncestor(int degree)
                           throws javax.jcr.ItemNotFoundException,
                                  javax.jcr.AccessDeniedException,
                                  javax.jcr.RepositoryException

Specified by:

getAncestor in interface javax.jcr.Item

Throws:

javax.jcr.ItemNotFoundException

javax.jcr.AccessDeniedException

javax.jcr.RepositoryException

getPath

public java.lang.String getPath()
                         throws javax.jcr.RepositoryException

Specified by:

getPath in interface javax.jcr.Item

Throws:

javax.jcr.RepositoryException

getDepth

public int getDepth()
             throws javax.jcr.RepositoryException

Specified by:

getDepth in interface javax.jcr.Item

Throws:

javax.jcr.RepositoryException

getSession

public javax.jcr.Session getSession()

Returns the session associated with this item.

Since Jackrabbit 1.4 it is safe to use this method regardless of item state.

Specified by:

getSession in interface javax.jcr.Item

Returns:

current session

See Also:

http://issues.apache.org/jira/browse/JCR-911

isSame

public boolean isSame(javax.jcr.Item otherItem)
               throws javax.jcr.RepositoryException

Specified by:

isSame in interface javax.jcr.Item

Throws:

javax.jcr.RepositoryException

toString

public java.lang.String toString()

Returns the(safe) path of this item for use in diagnostic output.

Overrides:

toString in class java.lang.Object

Returns:

"/path/to/item"