org.tridas.io.naming
Class AbstractNamingConvention

java.lang.Object
  extended by org.tridas.io.naming.AbstractNamingConvention
All Implemented Interfaces:
INamingConvention
Direct Known Subclasses:
HierarchicalNamingConvention, KeycodeNamingConvention, NumericalNamingConvention, SeriesCodeNamingConvention, SeriesNamingConvention, UUIDNamingConvention

public abstract class AbstractNamingConvention
extends Object
implements INamingConvention

Author:
daniel

Nested Class Summary
protected static class AbstractNamingConvention.DendoFileInfo
           
 
Field Summary
protected  Boolean addSequenceNumbersForUniqueness
           
static String DEFAULT_FILENAME
           
 
Constructor Summary
AbstractNamingConvention()
           
 
Method Summary
 void clearRegisteredFiles()
           
protected abstract  String getDendroFilename(IDendroFile argFile, org.tridas.schema.TridasProject argProject, org.tridas.schema.TridasDerivedSeries argSeries)
           
protected abstract  String getDendroFilename(IDendroFile argFile, org.tridas.schema.TridasProject argProject, org.tridas.schema.TridasObject argObject, org.tridas.schema.TridasElement argElement, org.tridas.schema.TridasSample argSample, org.tridas.schema.TridasRadius argRadius, org.tridas.schema.TridasMeasurementSeries argSeries)
           
abstract  String getDescription()
           
 String getFilename(IDendroFile argFile)
           
abstract  String getName()
           
 void registerFile(IDendroFile argFile, org.tridas.schema.TridasProject argProject, org.tridas.schema.TridasDerivedSeries argSeries)
           
 void registerFile(IDendroFile argFile, org.tridas.schema.TridasProject argProject, org.tridas.schema.TridasObject argObject, org.tridas.schema.TridasElement argElement, org.tridas.schema.TridasSample argSample, org.tridas.schema.TridasRadius argRadius, org.tridas.schema.TridasMeasurementSeries argSeries)
           
 void setAddSequenceNumbersForUniqueness(Boolean b)
          Set whether sequential numbers should be added to the filenames if there is more than one file.
 void setFilename(IDendroFile argFile, String argFilename)
          Sets the filename manually.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_FILENAME

public static String DEFAULT_FILENAME

addSequenceNumbersForUniqueness

protected Boolean addSequenceNumbersForUniqueness
Constructor Detail

AbstractNamingConvention

public AbstractNamingConvention()
Method Detail

registerFile

public void registerFile(IDendroFile argFile,
                         org.tridas.schema.TridasProject argProject,
                         org.tridas.schema.TridasObject argObject,
                         org.tridas.schema.TridasElement argElement,
                         org.tridas.schema.TridasSample argSample,
                         org.tridas.schema.TridasRadius argRadius,
                         org.tridas.schema.TridasMeasurementSeries argSeries)
Specified by:
registerFile in interface INamingConvention
See Also:
INamingConvention.registerFile(org.tridas.io.IDendroFile, org.tridas.schema.TridasProject, org.tridas.schema.TridasObject, org.tridas.schema.TridasElement, org.tridas.schema.TridasSample, org.tridas.schema.TridasRadius, org.tridas.schema.TridasMeasurementSeries)

registerFile

public void registerFile(IDendroFile argFile,
                         org.tridas.schema.TridasProject argProject,
                         org.tridas.schema.TridasDerivedSeries argSeries)
Specified by:
registerFile in interface INamingConvention
See Also:
INamingConvention.registerFile(org.tridas.io.IDendroFile, org.tridas.schema.TridasProject, org.tridas.schema.TridasDerivedSeries)

getDendroFilename

protected abstract String getDendroFilename(IDendroFile argFile,
                                            org.tridas.schema.TridasProject argProject,
                                            org.tridas.schema.TridasObject argObject,
                                            org.tridas.schema.TridasElement argElement,
                                            org.tridas.schema.TridasSample argSample,
                                            org.tridas.schema.TridasRadius argRadius,
                                            org.tridas.schema.TridasMeasurementSeries argSeries)

getDendroFilename

protected abstract String getDendroFilename(IDendroFile argFile,
                                            org.tridas.schema.TridasProject argProject,
                                            org.tridas.schema.TridasDerivedSeries argSeries)

clearRegisteredFiles

public void clearRegisteredFiles()

getFilename

public String getFilename(IDendroFile argFile)
Specified by:
getFilename in interface INamingConvention
See Also:
INamingConvention.getFilename(org.tridas.io.IDendroFile)

setFilename

public void setFilename(IDendroFile argFile,
                        String argFilename)
Description copied from interface: INamingConvention
Sets the filename manually.

Specified by:
setFilename in interface INamingConvention
See Also:
org.tridas.io.naming.INamingConvention#setOverridingFilename(org.tridas.io.IDendroFile, java.lang.String)

setAddSequenceNumbersForUniqueness

public void setAddSequenceNumbersForUniqueness(Boolean b)
Set whether sequential numbers should be added to the filenames if there is more than one file. Default is TRUE.

Parameters:
b -

getDescription

public abstract String getDescription()
Specified by:
getDescription in interface INamingConvention
See Also:
INamingConvention.getDescription()

getName

public abstract String getName()
Specified by:
getName in interface INamingConvention


Copyright © 2011. All Rights Reserved.