RBResource (Rational Developer for Power Systems Software API Reference)

Overview

Package

Class

Tree

Serialized

Deprecated

Index

Help

Rational Developer for Power Systems Software
V7.6

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.etools.iseries.remotebuild
Class RBResource

java.lang.Object
  com.ibm.etools.iseries.remotebuild.RBResource

Direct Known Subclasses:: RBProject, RBQSYSResource

public abstract class RBResource
extends Object
extends Object

RBResource is the abstract class of all resources that support remote build. The RB* hierarchy supports the writing of synchronization snapshots and various remote operations.

An RBResource has a gender that reflects its type on the remote system. It also has a namespace in which its name is considered unique in some sense.

An RBResource can be one of 3 general types:

a snapshot resource that is read from a snapshot file snapshot resources keep track of timestamp information associated with a resource that may or may not currently exist. Typically used to determine deltas from the last time the resource was pushed.
a local resource that is actually present in the workspace.
a remote resource that is present in the model but does not have a resource in the local workspace.

Field Summary
`static String`	`Copyright`
`static int`	`G_BINARYOBJECT` The gender of an object is a value that represents its type on the remote system.
`static int`	`G_LIBRARY` The gender of an object is a value that represents its type on the remote system.
`static int`	`G_MEMBER` The gender of an object is a value that represents its type on the remote system.
`static int`	`G_PROJECT` The gender of an object is a value that represents its type on the remote system.
`static int`	`G_SAVEFILE` The gender of an object is a value that represents its type on the remote system.
`static int`	`G_SOURCEFILE` The gender of an object is a value that represents its type on the remote system.
`static int`	`G_UNKNOWN` The gender of an object is a value that represents its type on the remote system.
`static int`	`NS_LOCAL`
`static int`	`NS_NETWORK`
`static int`	`NS_QSYS`
`static int`	`NS_UNKNOWN`
`static String`	`RB_QUALIFIER`

Constructor Summary
`protected`	`RBResource(AbstractISeriesResource resource)` Constructs an RBResource from a model resource.
`protected`	`RBResource(String name, long localStamp, long targetStamp)` Constructs an RBResource from its snapshot information.

Method Summary
`void`	`accept(RBResourceVisitor visitor)` Accepts a resource visitor.
`void`	`addChild(RBResource child)` Adds a child to this resource and sets the child's parent to this resource.
`boolean`	`attach(RBResource companion)` Attaches another resource to this one.
`RBStatus`	`checkAuthorities(String[] authorities)` Checks the authorities of a remote resource that is the companion of the current resource.
`RBStatus`	`checkContentsOn(RBSystem system)` Checks the contents of the local resource against those of the target system resource.
`RBStatus`	`checkExistence()` Checks the existence of a remote resource that is the companion of this resource.
`RBStatus`	`checkName()` Checks the name of this path for validity.
`RBStatus`	`checkPropertiesOn(RBSystem system)` Checks the properties of the local resource against those of the remote resource.
`protected void`	`checkProperty(Collection<String> modified, com.ibm.etools.iseries.projects.internal.snapshots.SnapshotRecord sr, String attributeName, String propertyName)` Adds a property name to the list of modified properties if it is modified from its snapshot value.
`void`	`clearMark(int n)` Clears a mark on the resource.
`void`	`clearMarks()` Clears all marks on the resource.
`RBResource`	`copy()` Returns a copy of this resource with no children.
`abstract RBStatus`	`createOn(RBSystem system)` Creates the corresponding resource on the system.
`abstract boolean`	`existsOn(RBSystem system)` Checks to see if the resource's counterpart exists on the target system.
`RBResource`	`findResource(LinkedList resourcePath)` Returns the resource found by following the path from this resource.
`Object`	`getAdapter(Class targetType)` Returns the adapter for this resource for the given class.
`abstract List`	`getAllProperties()` Returns a set of all the property names this resource.
`List`	`getAncestors()` Gets the local ancestors of a single resource up to its project resource.
`IResource`	`getBaseResource()` Returns the base resource associated with this resource.
`String`	`getCCSID()`
`RBResource`	`getChild(String key)` Returns a child with the given short key.
`RBResource[]`	`getChildren()` Returns an array of children of this resource.
`RBResource`	`getCompanion()` Retrieves the companion resource.
`RBResourceContext`	`getContext()`
`String`	`getDBCS()`
`List`	`getDescendents()` Returns a List of all local resources in the tree rooted at a particular resource.
`String`	`getDescription()`
`abstract int`	`getGender()` Returns the type of this resource -- see constants.
`RBResource`	`getHome()` Returns the home resource for this resource.
`RBResource`	`getHome(int nameSpace)` Returns the home resource for the given name space.
`abstract String`	`getIFSName()` Returns the IFS name of the object from the path.
`List<String>`	`getKeyPath()`
`long`	`getLocalStamp()` Returns the local stamp of this resource.
`protected String`	`getLocation()` Returns the absolute path name string to the local resource.
`String`	`getLongKey()` Returns a string unique to this resource that can be used to create the "canonical" ordering of local resources in the workspace.
`List`	`getModelChildren()`
`AbstractISeriesResource`	`getModelParent()`
`AbstractISeriesProject`	`getModelProject()` Returns the model project for this resource.
`String`	`getModelProperty(String name)` Returns a property of this resource maintained by the model.
`AbstractISeriesResource`	`getModelResource()` Returns the model resource associated with this resource.
`abstract Collection<String>`	`getModifiedProperties(com.ibm.etools.iseries.projects.internal.snapshots.SnapshotRecord sr)`
`String`	`getName()` Returns the name of this resource
`abstract int`	`getNameSpace()` Returns the name space for this resource -- see constants.
`int`	`getNumberOfChildren()` Returns the number of children this resource has.
`RBResource`	`getParent()` Returns the parent of this resource.
`String`	`getPersistentProperty(String name)` Returns a persistent property for a resource.
`RBProject`	`getProject()` Returns the project resource for a resource.
`String`	`getProjectProperty(String name)` Returns a model property on the project for this resource.
`abstract IPath`	`getProjectRelativePath()` Returns the project relative path of this resource.
`IISeriesPropertiesModel`	`getPropertiesModel()` Gets the properties model for this resource.
`abstract String`	`getQSYSName()` Returns the QSYS name space name of the object.
`String`	`getRecordLength()`
`String`	`getRemoteName()` Returns the displayable name for this resource on the remote system.
`LinkedList`	`getResourcePath()` Returns the path to this resource from its root resource.
`Object`	`getSessionProperty(String name)` Returns a "remote build" session property for a resource.
`String`	`getShortKey()` Returns a value that may be used as a key for this resource in the context of its parent.
`abstract String`	`getSnapshotType()` Returns the snapshot type for this class.
`String`	`getSourceType()`
`RBSystem`	`getSystem()` Returns the target system for this resource.
`String`	`getSystemName()` Returns the system name of the current target system for this resource.
`long`	`getTargetStamp()` Returns the target stamp of this resource.
`boolean`	`hasChildren()` Returns true if this resource has children.
`boolean`	`hasContents()`
`boolean`	`hasContext()`
`int`	`hashCode()` Returns the hashCode for this resource.
`boolean`	`hasMark(int n)` Return true if the resource has a particular mark.
`boolean`	`isEquivalentTo(Object o)` Returns true if and only if the resources identify the same iSeries object.
`boolean`	`isHome()` Returns true if this is a home resource.
`boolean`	`isLocal()` Returns true if the resource exists in the local workspace.
`boolean`	`isMarked()` Return true if the resource is marked by any mark.
`boolean`	`isProject()` Returns true if this is a project resource.
`boolean`	`isRemote()` Returns true if the resource is a remote resource.
`boolean`	`isSnapshot()` Returns true if the resource is a snapshot resource.
`static RBResource`	`makeFrom(AbstractISeriesResource modelResource)` Returns a resource made from a model resource.
`static RBResource`	`makeFrom(AbstractISeriesResource modelResource, RBResourceContext context)` Returns a resource made from a model resource with respect to the context.
`static RBResource`	`makeFrom(int gender, String snapshotName, long localStamp, long targetStamp)` Makes a new resource from its basic information.
`RBStatus`	`pushContentsTo(RBSystem system)` Pushes the contents of a resource to a target system.
`RBStatus`	`pushPropertiesTo(RBSystem system)` Pushes the properties to a target system.
`RBStatus`	`pushPropertiesTo(RBSystem system, Collection properties)` Pushes the properties named in the set to the target system resource.
`RBStatus`	`pushSourceTypeTo(RBSystem system)` Pushes the source type of this resource to the target system.
`QualifiedName`	`qualify(String name)` Qualifies a name with the remote build qualifier for use as a property name.
`void`	`removeChild(String key)` Removes a child from a parent.
`void`	`saveModelProperties()` Saves the model properties.
`void`	`setCompanion(RBResource companion)` Sets the companion resource.
`void`	`setContext(RBResourceContext context)` Sets the resolution context for this resource.
`void`	`setLocalStamp(long stamp)` Sets the local stamp of this resource.
`void`	`setMark(int n)` Sets a mark on the resource.
`void`	`setModelProperty(String name, String value)` Sets a model property for this resource.
`protected void`	`setName(String name)` Sets the short name of this resource.
`void`	`setPersistentProperty(String name, String property)` Sets a persistent property for a resource.
`void`	`setProjectProperty(String name, String value)` Sets a model property on the project for this resource.
`void`	`setSessionProperty(String name, Object property)` Sets a session property for a resource.
`void`	`setSourceType(String type)` Sets the source type for this resource.
`void`	`setTargetStamp(long stamp)` Sets the target stamp of this resource.
`void`	`synchronize()` Synchronizes the properties of this resource.
`String`	`toString()`
`void`	`updateFrom(RBResource r)` Updates a resources stamps from the argument.
`boolean`	`wasCreated()` Returns true if the resource has been created with respect to its companion resource.
`boolean`	`wasDeleted()` Returns true if the resource has been deleted with respect to its companion resource.
`boolean`	`wasModified()` Returns true if the resource has been modified with respect to its companion resource.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait`

Field Detail

Copyright

public static final String Copyright

See Also:: Constant Field Values

NS_UNKNOWN

public static final int NS_UNKNOWN

See Also:: Constant Field Values

NS_LOCAL

public static final int NS_LOCAL

See Also:: Constant Field Values

NS_QSYS

public static final int NS_QSYS

See Also:: Constant Field Values

NS_NETWORK

public static final int NS_NETWORK

See Also:: Constant Field Values

RB_QUALIFIER

public static final String RB_QUALIFIER

See Also:: Constant Field Values