Package org.apache.openjpa.meta

Class NonPersistentMetaData

java.lang.Object

org.apache.openjpa.meta.NonPersistentMetaData

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable, SourceTracker, Commentable, MetaDataContext

public class NonPersistentMetaData
extends java.lang.Object
implements java.lang.Comparable, SourceTracker, Commentable, MetaDataContext, java.io.Serializable

Metadata about a persistence-aware type.

Author:

Pinaki Poddar

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	TYPE_NON_MAPPED_INTERFACE
static int	TYPE_PERSISTENCE_AWARE

Fields inherited from interface org.apache.openjpa.lib.xml.Commentable

EMPTY_COMMENTS

Fields inherited from interface org.apache.openjpa.lib.meta.SourceTracker

SRC_ANNOTATIONS, SRC_OTHER, SRC_XML

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NonPersistentMetaData(java.lang.Class cls, MetaDataRepository repos, int type)

Method Summary

Modifier and Type	Method	Description
int	compareTo(java.lang.Object o)
int	getColNumber()	Return the column number in the line of the file at which this instance was parsed.
java.lang.String[]	getComments()	Return comments, or empty array if none.
java.lang.Class	getDescribedType()	Persistence-aware type.
int	getLineNumber()	Return the line number of the file at which this instance was parsed.
int	getListingIndex()	The index in which this class was listed in the metadata.
MetaDataRepository	getRepository()	Owning repository.
java.lang.String	getResourceName()	Return the domain-meaningful name of the resource that was loaded from this source.
java.io.File	getSourceFile()	Return the file from which this instance was parsed.
java.lang.Object	getSourceScope()	Return the domain-dependent scope of this instance within its file.
int	getSourceType()	Return the type of source.
int	getType()	The type of metadata.
void	setColNumber(int colNum)
void	setComments(java.lang.String[] comments)	Set comments.
void	setLineNumber(int lineNum)
void	setListingIndex(int index)	The index in which this field was listed in the metadata.
void	setSource(java.io.File file, int srcType)

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_PERSISTENCE_AWARE

public static final int TYPE_PERSISTENCE_AWARE

See Also:

Constant Field Values

TYPE_NON_MAPPED_INTERFACE

public static final int TYPE_NON_MAPPED_INTERFACE

See Also:

Constant Field Values

Constructor Detail

NonPersistentMetaData

protected NonPersistentMetaData(java.lang.Class cls,
                                MetaDataRepository repos,
                                int type)

Method Detail

getRepository

public MetaDataRepository getRepository()

Owning repository.

Specified by:

getRepository in interface MetaDataContext

getDescribedType

public java.lang.Class getDescribedType()

Persistence-aware type.

getType

public int getType()

The type of metadata.

getListingIndex

public int getListingIndex()

The index in which this class was listed in the metadata. Defaults to -1 if this class was not listed in the metadata.

setListingIndex

public void setListingIndex(int index)

The index in which this field was listed in the metadata. Defaults to -1 if this class was not listed in the metadata.

getSourceFile

public java.io.File getSourceFile()

Description copied from interface: SourceTracker

Return the file from which this instance was parsed.

Specified by:

getSourceFile in interface SourceTracker

getSourceScope

public java.lang.Object getSourceScope()

Description copied from interface: SourceTracker

Return the domain-dependent scope of this instance within its file.

Specified by:

getSourceScope in interface SourceTracker

getSourceType

public int getSourceType()

Description copied from interface: SourceTracker

Return the type of source.

Specified by:

getSourceType in interface SourceTracker

setSource

public void setSource(java.io.File file,
                      int srcType)

getLineNumber

public int getLineNumber()

Description copied from interface: SourceTracker

Return the line number of the file at which this instance was parsed.

Specified by:

getLineNumber in interface SourceTracker

setLineNumber

public void setLineNumber(int lineNum)

getColNumber

public int getColNumber()

Description copied from interface: SourceTracker

Return the column number in the line of the file at which this instance was parsed.

Specified by:

getColNumber in interface SourceTracker

setColNumber

public void setColNumber(int colNum)

getResourceName

public java.lang.String getResourceName()

Description copied from interface: SourceTracker

Return the domain-meaningful name of the resource that was loaded from this source. I.e., if we had loaded the source for a Java class, this would return the name of the class.

Specified by:

getResourceName in interface SourceTracker

getComments

public java.lang.String[] getComments()

Description copied from interface: Commentable

Return comments, or empty array if none.

Specified by:

getComments in interface Commentable

setComments

public void setComments(java.lang.String[] comments)

Description copied from interface: Commentable

Set comments.

Specified by:

setComments in interface Commentable

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable