com.ibm.etools.iseries.perspective.model
Class AbstractISeriesNativeObject

java.lang.Object
  com.ibm.etools.iseries.perspective.model.AbstractISeriesResource
      com.ibm.etools.iseries.perspective.model.AbstractISeriesParent
          com.ibm.etools.iseries.perspective.model.AbstractISeriesContainer
              com.ibm.etools.iseries.perspective.model.AbstractISeriesNativeObject

All Implemented Interfaces:

IISeriesResourceActionFilter

public abstract class AbstractISeriesNativeObject
extends AbstractISeriesContainer

This represents a native container. It can be any iSeries object that has members (e.g. SRCPF, or a data file). OR it can be an LEAF object that does not have any children, e.g. save file, or program file. This means that we can either have an IContainer or an IFile associated with a native object. AND we can have either an AS400Object or an AS400File associated with this object also.

Field Summary

protected IFile	baseIFile
protected IQSYSObject	baseISeriesObject
static String	Copyright
protected TreeMap<String,AbstractISeriesNativeMember>	nativeMembers

Fields inherited from class com.ibm.etools.iseries.perspective.model.AbstractISeriesContainer

baseIContainer, cachedRemoteObjects

Fields inherited from class com.ibm.etools.iseries.perspective.model.AbstractISeriesResource

CONTAINER, IFS_CONTAINER, IFS_MEMBER, IFS_ROOT, LOCAL, LOCAL_AND_REMOTE, MEMBER, NATIVE_LIBRARY, NATIVE_MEMBER, NATIVE_OBJECT, NATIVE_ROOT, PROJECT, PROJECT_ROOT, REMOTE

Fields inherited from interface com.ibm.etools.iseries.perspective.model.IISeriesResourceActionFilter

IS_LEAF_OBJECT, IS_LOCAL, IS_NATIVE, IS_SOURCE_FILE, IS_SYNCHRONIZED, METADATA_LEVEL

Constructor Summary

AbstractISeriesNativeObject()

Method Summary

void	addNativeMember(AbstractISeriesNativeMember member) Add a new member for the nativeMembers collection.
boolean	findMatchingMember(String targetName, boolean getExactMatch, boolean includeRemote, List<AbstractISeriesNativeMember> resultCollector) Find the AbstractISeriesNativeMember that has a name that matches the given target name.
IFile	getBaseIFile() Access method for the baseIFile property.
IQSYSObject	getBaseISeriesObject() Access method for the baseISeriesObject property.
AbstractISeriesNativeMember[]	getNativeMemberArray() Return the native members as a read-only sorted array This is not intended to be updated
Iterator<AbstractISeriesNativeMember>	getNativeMembers() A read-only iterator of the native members in this object
AbstractISeriesNativeLibrary	getParentLibrary() Access method for the parentLibrary property.
AbstractISeriesNativeRoot	getParentRoot() Access method for the parentRoot property.
String	getResourceName() Return the name of the IResource or IQSYSResource that this is wrappering
abstract boolean	isBinaryObject() Returns whether or not this object represents a Binary Object File.
abstract boolean	isLeafObject() Returns whether or not this object represents a leaf object.
abstract boolean	isSourceFile() Returns whether or not this object represents an iSeries Source Physical File.
void	removeNativeMember(AbstractISeriesNativeMember member) Remove a member from the nativeMembers collection
void	setBaseIFile(IFile aBaseIFile) Sets the value of the baseIFile property.
void	setBaseISeriesObject(IQSYSObject aBaseISeriesObject) Sets the value of the baseISeriesObject property.
void	setParentLibrary(AbstractISeriesNativeLibrary aParentLibrary) Sets the value of the parentLibrary property.
void	setParentRoot(AbstractISeriesNativeRoot aParentRoot) Sets the value of the parentRoot property.

Methods inherited from class com.ibm.etools.iseries.perspective.model.AbstractISeriesContainer

clearRemoteObjectsCache, getBaseIContainer, getCachedRemoteObjects, getChildren, getRemoteIncluded, getType, hasChildren, setBaseIContainer, setRemoteIncluded

Methods inherited from class com.ibm.etools.iseries.perspective.model.AbstractISeriesParent

collectAllChildren, findiSeriesResource

Methods inherited from class com.ibm.etools.iseries.perspective.model.AbstractISeriesResource

accept, getAdapter, getBaseIResource, getISeriesProject, getIsLocal, getIsNative, getIsSynchronized, getLocationMask, getMarkerSeverity, getParent, getPropertiesModel, refreshPropertiesModel, setIsLocal, setIsNative, setIsSynchronized, synchronize, testAttribute, toString

Methods inherited from class java.lang.Object

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

Field Detail

Copyright

public static final String Copyright

See Also:

Constant Field Values

nativeMembers

protected TreeMap<String,AbstractISeriesNativeMember> nativeMembers

baseIFile

protected IFile baseIFile

baseISeriesObject

protected IQSYSObject baseISeriesObject

Constructor Detail

AbstractISeriesNativeObject

public AbstractISeriesNativeObject()

Method Detail

isLeafObject

public abstract boolean isLeafObject()

Returns whether or not this object represents a leaf object. A leaf object is something like a .savf file or a prg.

isSourceFile

public abstract boolean isSourceFile()

Returns whether or not this object represents an iSeries Source Physical File.

isBinaryObject

public abstract boolean isBinaryObject()

Returns whether or not this object represents a Binary Object File.

getParentRoot

public AbstractISeriesNativeRoot getParentRoot()

Access method for the parentRoot property.

Returns:

the current value of the parentRoot property

setParentRoot

public void setParentRoot(AbstractISeriesNativeRoot aParentRoot)

Sets the value of the parentRoot property.

Parameters:

aParentRoot - the new value of the parentRoot property

getParentLibrary

public AbstractISeriesNativeLibrary getParentLibrary()

Access method for the parentLibrary property.

Returns:

the current value of the parentLibrary property

setParentLibrary

public void setParentLibrary(AbstractISeriesNativeLibrary aParentLibrary)

Sets the value of the parentLibrary property.

Parameters:

aParentLibrary - the new value of the parentLibrary property

getNativeMembers

public Iterator<AbstractISeriesNativeMember> getNativeMembers()

A read-only iterator of the native members in this object

Returns:

an iterator over the native members in this src pf

addNativeMember

public void addNativeMember(AbstractISeriesNativeMember member)

Add a new member for the nativeMembers collection.

removeNativeMember

public void removeNativeMember(AbstractISeriesNativeMember member)

Remove a member from the nativeMembers collection

getBaseIFile

public IFile getBaseIFile()

Access method for the baseIFile property.

Returns:

the current value of the baseIFile property

setBaseIFile

public void setBaseIFile(IFile aBaseIFile)

Sets the value of the baseIFile property.

Parameters:

aBaseIFile - the new value of the baseIFile property

getBaseISeriesObject

public IQSYSObject getBaseISeriesObject()

Access method for the baseISeriesObject property.

Returns:

the current value of the baseISeriesObject property

setBaseISeriesObject

public void setBaseISeriesObject(IQSYSObject aBaseISeriesObject)

Sets the value of the baseISeriesObject property.

Parameters:

aBaseISeriesObject - the new value of the baseISeriesObject property

findMatchingMember

public boolean findMatchingMember(String targetName,
                                  boolean getExactMatch,
                                  boolean includeRemote,
                                  List<AbstractISeriesNativeMember> resultCollector)

Find the AbstractISeriesNativeMember that has a name that matches the given target name.

Parameters:

targetName - - the name of the member we are looking for

getExactMatch - - if this is true, search on both the name and extension, if it is false then ignore the extension when looking for a match.

skipThisMember - - skip this member when searching for a match, if it is null, that do not skip any

includeRemote - - if true that include remote members in the search

Returns:

whether any members are found that conflict with the given name

getNativeMemberArray

public AbstractISeriesNativeMember[] getNativeMemberArray()

Return the native members as a read-only sorted array This is not intended to be updated

getResourceName

public String getResourceName()

Return the name of the IResource or IQSYSResource that this is wrappering

Returns: