net.praqma.clearcase.ucm.view

Class SnapshotView

java.lang.Object

net.praqma.clearcase.Cool

net.praqma.clearcase.ClearCase

net.praqma.clearcase.ucm.view.UCMView

net.praqma.clearcase.ucm.view.SnapshotView

All Implemented Interfaces:

Serializable

public class SnapshotView
extends UCMView

Author:

wolfgang

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SnapshotView.Components
static class	SnapshotView.LoadRules2
class	SnapshotView.UpdateInfo
static class	SnapshotView.ViewPrivateFileFilter

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	pattern_cache
static Pattern	pattern_catcs
static String	rx_co_file
static String	rx_ctr_file
static String	rx_keep_file
static String	rx_updt_file
static Pattern	rx_view_rebasing
protected static Pattern	rx_view_uuid
protected static Pattern	rx_view_uuid_file

Fields inherited from class net.praqma.clearcase.ucm.view.UCMView

dynamic, path, rx_view_get_path, RX_VIEW_ROOT, storageLocation, viewtag

Fields inherited from class net.praqma.clearcase.ClearCase

rx_attr_find

Fields inherited from class net.praqma.clearcase.Cool

delim, filesep, filesepChar, linesep, qfs, qfsor

Constructor Summary

Constructors

Constructor and Description
SnapshotView()
SnapshotView(File viewroot)

Method Summary

Modifier and Type	Method and Description
static List<String>	catcs(File viewRoot)
static SnapshotView	create(Stream stream, File viewroot, String viewtag) Create a Snapshot view given a Stream, view root and a view tag.
static void	createEnvironment(File viewroot)
static void	createEnvironment(File viewroot, String viewtagsuffix)
static SnapshotView	get(File viewroot)
List<String>	getAllLoadLines()
static HashMap<String,Boolean>	getAllLoadStrings(File viewRoot)
static HashMap<String,Boolean>	getAllLoadStrings(List<String> consoleIn)
File	getCurrentViewRoot(File viewroot)
String	getPath()
List<String>	getReadOnlyLoadLines()
static SnapshotView	getSnapshotViewFromPath(File viewroot)
Stream	getStream()
net.praqma.util.structure.Tuple<Stream,String>	getStreamFromView(File vr)
String	getStreamFromView(String viewtag)
File	getViewRoot()
static String	getViewtag(File context)
static boolean	isSpecialFile(String file)
static void	regenerateViewDotDat(File dir, String viewtag)
void	setAllLoadLines(List<String> allLoadLines)
void	setReadOnlyLoadLines(List<String> readOnlyLoadLines)
Map<String,Integer>	swipe(boolean excludeRoot, String loadRules)
Map<String,Integer>	swipe(File viewroot, boolean excludeRoot)
Map<String,Integer>	swipe(File viewroot, boolean excludeRoot, String loadrules)
SnapshotView.UpdateInfo	update(boolean swipe, boolean generate, boolean overwrite, boolean excludeRoot, SnapshotView.LoadRules2 loadRules) TODO: This one should be used for new method of updating
static String	viewrootIsValid(File viewroot) Determine if the views view root is valid, returning its view tag

Methods inherited from class net.praqma.clearcase.ucm.view.UCMView

create, createViewFromGlobalStoragePath, end, end, equals, exists, getFullyQualifiedName, getStorageLocation, getView, getViews, getViewtag, hashCode, isDynamicView, load, remove, setActivity, setPath, setViewTag, start, start, toString, viewExists

Methods inherited from class net.praqma.clearcase.ClearCase

createSimpleAttributeType, getAttribute, getAttributes, getAttributes, getAttributes, setAttribute, setAttribute

Methods inherited from class net.praqma.clearcase.Cool

getOS

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

rx_view_uuid_file

protected static final Pattern rx_view_uuid_file

rx_view_uuid

protected static final Pattern rx_view_uuid

rx_view_rebasing

public static final Pattern rx_view_rebasing

pattern_cache

public static final Pattern pattern_cache

pattern_catcs

public static final Pattern pattern_catcs

rx_co_file

public static final String rx_co_file

See Also:

Constant Field Values

rx_ctr_file

public static final String rx_ctr_file

See Also:

Constant Field Values

rx_keep_file

public static final String rx_keep_file

See Also:

Constant Field Values

rx_updt_file

public static final String rx_updt_file

See Also:

Constant Field Values

Constructor Detail

SnapshotView

public SnapshotView()

SnapshotView

public SnapshotView(File viewroot)
             throws UnableToInitializeEntityException,
                    CleartoolException,
                    ViewException,
                    IOException

Throws:

UnableToInitializeEntityException

CleartoolException

ViewException

IOException

Method Detail

catcs

public static List<String> catcs(File viewRoot)

getAllLoadStrings

public static HashMap<String,Boolean> getAllLoadStrings(List<String> consoleIn)

getAllLoadStrings

public static HashMap<String,Boolean> getAllLoadStrings(File viewRoot)

isSpecialFile

public static boolean isSpecialFile(String file)

create

public static SnapshotView create(Stream stream,
                                  File viewroot,
                                  String viewtag)
                           throws ViewException,
                                  UnableToInitializeEntityException,
                                  CleartoolException,
                                  IOException

Create a Snapshot view given a Stream, view root and a view tag.

Parameters:

stream - The Stream

viewroot - The root of this new view

viewtag - The tag to use

Returns:

SnapShotView The SnapshotView as a result of the creation

Throws:

ViewException - Thrown on ClearTool error, view cannot be created

UnableToInitializeEntityException - Thrown when a ClearTool error occurs

CleartoolException - Thrown on ClearTool error

IOException - File errors/other external non ClearTool errors

createEnvironment

public static void createEnvironment(File viewroot)

createEnvironment

public static void createEnvironment(File viewroot,
                                     String viewtagsuffix)

regenerateViewDotDat

public static void regenerateViewDotDat(File dir,
                                        String viewtag)
                                 throws IOException,
                                        UnableToListViewsException

Throws:

IOException

UnableToListViewsException

getReadOnlyLoadLines

public List<String> getReadOnlyLoadLines()

setReadOnlyLoadLines

public void setReadOnlyLoadLines(List<String> readOnlyLoadLines)

getAllLoadLines

public List<String> getAllLoadLines()

setAllLoadLines

public void setAllLoadLines(List<String> allLoadLines)

getViewRoot

public File getViewRoot()

getPath

public String getPath()

Overrides:

getPath in class UCMView

getStream

public Stream getStream()
                 throws UnableToInitializeEntityException,
                        CleartoolException,
                        ViewException,
                        IOException

Overrides:

getStream in class UCMView

Throws:

UnableToInitializeEntityException

CleartoolException

ViewException

IOException

getViewtag

public static String getViewtag(File context)
                         throws CleartoolException

Throws:

CleartoolException

getSnapshotViewFromPath

public static SnapshotView getSnapshotViewFromPath(File viewroot)
                                            throws ClearCaseException,
                                                   IOException

Throws:

ClearCaseException

IOException

viewrootIsValid

public static String viewrootIsValid(File viewroot)
                              throws IOException,
                                     CleartoolException,
                                     ViewException

Determine if the views view root is valid, returning its view tag

Parameters:

viewroot - The view root (File)

Returns:

The view tag

Throws:

IOException - Thrown when the filesystem cannot find the files specified

CleartoolException - Thrown on ClearTool error

ViewException - Thrown on ClearTool error, the view was not created

getStreamFromView

public final net.praqma.util.structure.Tuple<Stream,String> getStreamFromView(File vr)
                                                                       throws UnableToInitializeEntityException,
                                                                              CleartoolException,
                                                                              ViewException,
                                                                              IOException

Throws:

UnableToInitializeEntityException

CleartoolException

ViewException

IOException

getCurrentViewRoot

public File getCurrentViewRoot(File viewroot)
                        throws ViewException

Throws:

ViewException

getStreamFromView

public String getStreamFromView(String viewtag)
                         throws ViewException

Throws:

ViewException

update

public SnapshotView.UpdateInfo update(boolean swipe,
                                      boolean generate,
                                      boolean overwrite,
                                      boolean excludeRoot,
                                      SnapshotView.LoadRules2 loadRules)
                               throws CleartoolException,
                                      ViewException

TODO: This one should be used for new method of updating

Parameters:

swipe - Swipe

generate - Generated

overwrite - Overview

excludeRoot - Exclude root

loadRules - Load rules

Returns:

An SnapshotView.UpdateInfo

Throws:

CleartoolException - Thrown on ClearTool error

ViewException - Thrown on ClearTool error

swipe

public Map<String,Integer> swipe(File viewroot,
                                 boolean excludeRoot)
                          throws CleartoolException

Throws:

CleartoolException

swipe

public Map<String,Integer> swipe(File viewroot,
                                 boolean excludeRoot,
                                 String loadrules)
                          throws CleartoolException

Throws:

CleartoolException

swipe

public Map<String,Integer> swipe(boolean excludeRoot,
                                 String loadRules)
                          throws CleartoolException

Throws:

CleartoolException

get

public static SnapshotView get(File viewroot)
                        throws IOException,
                               ViewException,
                               UnableToInitializeEntityException,
                               CleartoolException

Throws:

IOException

ViewException

UnableToInitializeEntityException

CleartoolException