|
iSeries Remote Systems v6.0.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.etools.iseries.core.resources.ISeriesEditableSrcPhysicalFileMember
A representation of a remote iSeries source member for the purpose of local editing
Field Summary | |
---|---|
static String |
Copyright
|
Fields inherited from interface com.ibm.etools.systems.subsystems.ICommunicationsListener |
---|
copyright |
Fields inherited from interface com.ibm.etools.systems.core.resources.ISystemTextEditorConstants |
---|
BIDI_LOGICAL_KEY, CCSID_KEY, EDITOR_PROFILE_TYPE, LOCAL_ENCODING_KEY, MAX_LINE_LENGTH_KEY, SEQUENCE_NUMBERS_KEY, SOURCE_ENCODING_KEY, SYSTEM_TEXT_BROWSER_ID, SYSTEM_TEXT_EDITOR_ID, TEMP_CCSID_KEY |
Fields inherited from interface com.ibm.etools.systems.core.resources.ISystemRemoteEditConstants |
---|
DEFAULT_EDITOR_PROFILE, DOWNLOAD_FILE_MODIFIED_STAMP, EDITOR_COMPARE_LOCATION, EDITOR_GET_FILE_LOCATION, LOAD_TYPE_KEY, LOAD_TYPE_USE_STRING, REMOTE_FILE_BINARY_TRANSFER, REMOTE_FILE_MODIFIED_STAMP, REMOTE_FILE_MOUNTED, REMOTE_FILE_OBJECT_KEY, REMOTE_FILE_PATH_KEY, REMOTE_FILE_SUBSYSTEM_KEY, RESOLVED_MOUNTED_REMOTE_FILE_HOST_KEY, RESOLVED_MOUNTED_REMOTE_FILE_PATH_KEY, TEMP_FILE_DIRTY, TEMP_FILE_READONLY, UNIVERSAL_EDITOR_PROFILE, UNIVERSAL_LOCAL_EDITOR_PROFILE |
Fields inherited from interface com.ibm.etools.iseries.core.resources.IISeriesRemoteEditConstants |
---|
AS400_OBJECT_KEY, IFS_EDITOR_PROFILE, QSYS_EDITOR_PROFILE |
Fields inherited from interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject |
---|
NOT_OPEN, OPEN_IN_DIFFERENT_PERSPECTIVE, OPEN_IN_SAME_PERSPECTIVE |
Constructor Summary | |
---|---|
ISeriesEditableSrcPhysicalFileMember(ISeriesMember member)
Constructor |
|
ISeriesEditableSrcPhysicalFileMember(ISeriesMember member,
boolean readonly)
Constructor |
Method Summary | |
---|---|
void |
addAsListener()
Register as listener for various events |
boolean |
canWrite()
|
int |
checkOpenInEditor()
Is the local file open in an editor |
void |
closeStream()
Close the member |
void |
communicationsStateChange(com.ibm.etools.systems.subsystems.CommunicationsEvent event)
|
void |
connect()
Connects and resets parameters, if not connected. |
void |
connect(Shell shell)
Connects and resets parameters, if not connected. |
void |
delete()
Delete the local resource |
boolean |
doImmediateSaveAndUpload()
Saves the local file and uploads it to the host immediately, rather than, in response to a resource change event. |
boolean |
download(IProgressMonitor monitor)
Download the member. |
boolean |
download(IProgressMonitor monitor,
boolean force)
Download the member. |
boolean |
download(IProgressMonitor monitor,
boolean force,
boolean doRefresh)
Download the member. |
boolean |
download(Shell shell)
Download the member. |
boolean |
download(Shell shell,
boolean force)
Download the member. |
boolean |
download(Shell shell,
boolean force,
boolean silent)
Download the member. |
boolean |
download(Shell shell,
boolean force,
boolean silent,
boolean doRefresh)
Download the member. |
IFile |
getAndCreateLocalResource()
Remote members that have been edited before are cached locally as an IFile in our own RSE tempfiles project. |
String |
getDownloadPath()
Gets the download path |
String |
getDownloadPath(ISeriesMember rmember)
Gets the download path |
com.ibm.etools.systems.editor.SystemTextEditor |
getEditor()
Get the editor |
IEditorPart |
getEditorPart()
Returns the open IEditorPart for this remote object if there is one. |
String |
getEditorTitle()
Get editor title |
String |
getFullName()
Return the fully qualified member name: library/object(member) |
ISeriesConnection |
getISeriesConnection()
Returns the ISeriesConnection from which this object originated. |
IFile |
getLocalResource()
Remote members that have been edited before are cached locally as an IFile in our own RSE tempfiles project. |
IFile |
getLocalResource(String alocalPath)
|
ISeriesMember |
getMember()
Return the ISeriesMember object representing this member |
protected String |
getOSPath(String path)
|
static long |
getRemoteMemberTimestamp(ISeriesMember remoteMember)
|
IAdaptable |
getRemoteObject()
Returns the remote object that is editable |
String |
getRemotePath()
Get the remote path. |
Verifier |
getVerifierForSourceType(String sourceType,
IFile iFile)
get the verifier for a source type and IFile |
static Verifier |
getVerifierForSourceTypeStatic(String sourceType,
IFile iFile)
get the verifier for a source type and IFile |
static Verifier |
getVerifierForSourceTypeStatic(String sourceType,
com.ibm.lpex.core.LpexView view)
get the verifier for a source type and LpexView |
static boolean |
isCOBOLSourceType(String sourceType)
check if there is source type is of type COBOL |
boolean |
isConnected()
Returns if connection is connected |
static boolean |
isDDSSourceType(String sourceType)
check if there is source type is of type DDS |
boolean |
isDirty()
|
static boolean |
isILERRPGSourceType(String sourceType)
check if there is source type is of type ILE RPG |
boolean |
isPassiveCommunicationsListener()
|
boolean |
isReadOnly()
is the editor readonly? |
static boolean |
isVerifiableSourceType(String sourceType)
check if there is a verifier, based on source type |
static boolean |
isVerifiableWithPromptSourceType(String sourceType)
check if there is a verifier that prompts for options, based on source type |
void |
open(Shell shell)
Open member in editor for read / write. |
void |
open(Shell shell,
boolean readOnly)
Open in editor in specified mode. |
void |
openEditor()
Open the editor |
boolean |
openIsCanceled()
Return if the open is canceled or not |
boolean |
openStream()
Open member for write. |
void |
partActivated(IWorkbenchPart part)
|
void |
partBroughtToTop(IWorkbenchPart part)
|
void |
partClosed(IWorkbenchPart part)
|
void |
partDeactivated(IWorkbenchPart part)
|
void |
partOpened(IWorkbenchPart part)
|
com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectLock |
queryLocks()
Query whether member is locked on the server. |
com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectLock |
queryLocks(ISeriesMember amember)
Query whether member is locked on the server. |
void |
refresh()
Refresh the remote edit project. |
boolean |
saveAs(ISeriesMember newMember,
IProgressMonitor progressMonitor)
Save as to a remote location |
void |
setContents(Shell shell,
String[] contents,
boolean upload)
Set the contents of the member in its local copy, and optionally upload it to the host |
void |
setEditor(IEditorPart editor)
Set the editor |
void |
setEditorAsReadOnly()
Set editor to read only |
void |
setInsertSequenceNumbersIfRequired(boolean insert)
Sets whether or not the upload should insert sequence numbers (default is true) |
void |
setISeriesMemberTransfer(ISeriesMemberTransfer transfer)
Sets the ISeriesMemberTransfer object to use to download/upload the member. |
void |
setLocalResourceProperties()
Set local resource properties |
void |
setLocalResourceProperties(boolean setCharset)
Set local resource properties Normally this method is not called directly, use setLocalResourceProperties() instead which calls this one with a parameter of true. |
void |
setLocalResourceProperties(boolean setCharset,
IFile file,
ISeriesMember currentmember)
|
void |
setMember(ISeriesMember member)
Set the remote member |
void |
setReadOnly(boolean flag)
|
void |
setTrace(boolean tracing)
Turn on tracing statements for debug purposes. |
void |
updateDirtyIndicator()
Update the dirty indicator |
void |
upload(IProgressMonitor monitor)
Upload the member to the iSeries. |
void |
upload(Shell shell)
Upload the member to the iSeries, with a progress monitor. |
String |
verify(boolean bPrompt)
Verify the member for syntactic and semantic errors |
static String |
verify(IFile iFile,
String sourceType,
boolean bPrompt)
Verify an IFile |
static String |
verify(com.ibm.etools.systems.core.resources.SystemEditableRemoteFile editableRemoteFile,
String sourceType,
boolean bPrompt)
Verify an IFile |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String Copyright
Constructor Detail |
public ISeriesEditableSrcPhysicalFileMember(ISeriesMember member) throws com.ibm.etools.systems.core.messages.SystemMessageException
public ISeriesEditableSrcPhysicalFileMember(ISeriesMember member, boolean readonly) throws com.ibm.etools.systems.core.messages.SystemMessageException
member
- the ISeriesMember to be opened in the editor.readonly
- Download the file as readonlyMethod Detail |
public void setMember(ISeriesMember member) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public ISeriesMember getMember()
public String getRemotePath()
public com.ibm.etools.systems.editor.SystemTextEditor getEditor()
public void connect() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public void connect(Shell shell) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public boolean isConnected()
public void closeStream() throws Exception
Exception
public boolean openStream() throws Exception
Exception
public void setTrace(boolean tracing)
public boolean download(Shell shell) throws Exception
download
in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
Exception
public boolean download(Shell shell, boolean force) throws Exception
force
- Force the member to be downloaded even if a local copy already exists with the same timestamp.
Exception
public boolean download(Shell shell, boolean force, boolean silent) throws Exception
force
- force the member to be downloaded even if a local copy already exists with the same timestamp.silent
- if the member is locked, download the member in silent mode without asking the user.
Exception
public boolean download(Shell shell, boolean force, boolean silent, boolean doRefresh) throws Exception
force
- force the member to be downloaded even if a local copy already exists with the same timestamp.silent
- if the member is locked, download the member in silent mode without asking the user.
Exception
public boolean download(IProgressMonitor monitor) throws Exception
download
in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
Exception
public boolean download(IProgressMonitor monitor, boolean force) throws Exception
monitor
- the progress monitor to show during the download. Can be null.force
- force a refresh of the RSE temp files project
Exception
public boolean download(IProgressMonitor monitor, boolean force, boolean doRefresh) throws Exception
monitor
- the progress monitor to show during the download. Can be null.force
- force a refresh of the RSE temp files project
Exception
public void setContents(Shell shell, String[] contents, boolean upload) throws Exception
Exception
public void upload(Shell shell) throws Exception
Exception
public void upload(IProgressMonitor monitor) throws Exception
Exception
public IFile getLocalResource()
getLocalResource
in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
public IFile getLocalResource(String alocalPath)
public IFile getAndCreateLocalResource()
public void delete()
public String getDownloadPath()
protected String getOSPath(String path)
public String getDownloadPath(ISeriesMember rmember)
public boolean isPassiveCommunicationsListener()
isPassiveCommunicationsListener
in interface com.ibm.etools.systems.subsystems.ICommunicationsListener
ICommunicationsListener.isPassiveCommunicationsListener()
public void communicationsStateChange(com.ibm.etools.systems.subsystems.CommunicationsEvent event)
communicationsStateChange
in interface com.ibm.etools.systems.subsystems.ICommunicationsListener
ICommunicationsListener#communicationsStateChanged(CommunicationsEvent)
public int checkOpenInEditor() throws CoreException
checkOpenInEditor
in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
CoreException
public void open(Shell shell)
open
in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
public void open(Shell shell, boolean readOnly)
open
in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
public com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectLock queryLocks() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectLock queryLocks(ISeriesMember amember) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public void setLocalResourceProperties() throws CoreException, com.ibm.etools.systems.core.messages.SystemMessageException, Exception
setLocalResourceProperties
in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
CoreException
com.ibm.etools.systems.core.messages.SystemMessageException
Exception
public void setLocalResourceProperties(boolean setCharset) throws CoreException, com.ibm.etools.systems.core.messages.SystemMessageException, Exception
setCharset
- true if you want to call file.setCharset() which causes a resource change event
CoreException
com.ibm.etools.systems.core.messages.SystemMessageException
Exception
public void setLocalResourceProperties(boolean setCharset, IFile file, ISeriesMember currentmember) throws CoreException, com.ibm.etools.systems.core.messages.SystemMessageException, Exception
CoreException
com.ibm.etools.systems.core.messages.SystemMessageException
Exception
public void addAsListener()
addAsListener
in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
public void openEditor() throws PartInitException
openEditor
in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
PartInitException
public String getEditorTitle()
public void setEditor(IEditorPart editor)
setEditor
in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
public void setEditorAsReadOnly()
public void setReadOnly(boolean flag)
setReadOnly
in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
public boolean isReadOnly()
isReadOnly
in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
public void refresh()
public void updateDirtyIndicator()
updateDirtyIndicator
in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
public void partActivated(IWorkbenchPart part)
partActivated
in interface IPartListener
IPartListener.partActivated(IWorkbenchPart)
public void partBroughtToTop(IWorkbenchPart part)
partBroughtToTop
in interface IPartListener
IPartListener.partBroughtToTop(IWorkbenchPart)
public static long getRemoteMemberTimestamp(ISeriesMember remoteMember)
public void partClosed(IWorkbenchPart part)
partClosed
in interface IPartListener
IPartListener.partClosed(IWorkbenchPart)
public void partDeactivated(IWorkbenchPart part)
partDeactivated
in interface IPartListener
IPartListener.partDeactivated(IWorkbenchPart)
public void partOpened(IWorkbenchPart part)
partOpened
in interface IPartListener
IPartListener.partOpened(IWorkbenchPart)
public Verifier getVerifierForSourceType(String sourceType, IFile iFile)
public static Verifier getVerifierForSourceTypeStatic(String sourceType, IFile iFile)
public static Verifier getVerifierForSourceTypeStatic(String sourceType, com.ibm.lpex.core.LpexView view)
sourceType
- type of the fileview
- the Lpex view associated with the file, if it is open in the editorpublic static boolean isVerifiableSourceType(String sourceType)
public static boolean isVerifiableWithPromptSourceType(String sourceType)
public static boolean isILERRPGSourceType(String sourceType)
public static boolean isCOBOLSourceType(String sourceType)
public static boolean isDDSSourceType(String sourceType)
public String verify(boolean bPrompt)
public static String verify(IFile iFile, String sourceType, boolean bPrompt)
iFile
- bPrompt
- public static String verify(com.ibm.etools.systems.core.resources.SystemEditableRemoteFile editableRemoteFile, String sourceType, boolean bPrompt)
editableRemoteFile
- the SystemEditableRemoteFile
that you can get from the SystemViewRemoteFile
bPrompt
- if true, the prompt dialog will be shownpublic boolean doImmediateSaveAndUpload()
doImmediateSaveAndUpload
in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
public boolean saveAs(ISeriesMember newMember, IProgressMonitor progressMonitor)
public boolean canWrite()
public boolean isDirty()
isDirty
in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
public IAdaptable getRemoteObject()
getRemoteObject
in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
public IEditorPart getEditorPart()
getEditorPart
in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
public boolean openIsCanceled()
public String getFullName()
public ISeriesConnection getISeriesConnection()
public void setISeriesMemberTransfer(ISeriesMemberTransfer transfer)
transfer
- The ISeriesMemberTransfer object to use for tranfering the member to/from the iSeriespublic void setInsertSequenceNumbersIfRequired(boolean insert)
insert
- true if you want to insert sequence numbers when uploading, false otherwise
|
iSeries Remote Systems v6.0.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |