Package jj2000.j2k
Class ModuleSpec
java.lang.Object
jj2000.j2k.ModuleSpec
- All Implemented Interfaces:
Cloneable
- Direct Known Subclasses:
AnWTFilterSpec,CBlkSizeSpec,CompTransfSpec,GuardBitsSpec,IntegerSpec,MaxShiftSpec,PrecinctSizeSpec,ProgressionSpec,QuantStepSizeSpec,QuantTypeSpec,StringSpec,SynWTFilterSpec
This generic class is used to handle values to be used by a module for each
tile and component. It uses attribute to determine which value to use. It
should be extended by each module needing this feature.
This class might be used for values that are only tile specific or
component specific but not both.
The attributes to use are defined by a hierarchy. The hierarchy is:
- Tile and component specific attribute
- Tile specific default attribute
- Component main default attribute
- Main default attribute
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Object[]The default value for each component.protected ObjectDefault value for each tile-componentprotected intThe number of componentsprotected intThe number of tilesstatic final byteThe identifier for "component default" specificationstatic final byteThe identifier for default specificationstatic final byteThe identifier for a "tile-component" specificationstatic final byteThe identifier for "tile default" specificationstatic final byteThe identifier for a specification module that applies only to componentsstatic final byteThe identifier for a specification module that applies only to tilesstatic final byteThe identifier for a specification module that applies both to tiles and componentsprotected StringThe specified value in string formatprotected intThe type of the specification moduleprotected byte[][]The spec type for each tile-component.protected HashtableThe specific value for each tile-component.protected Object[]The default value for each tile. -
Constructor Summary
ConstructorsConstructorDescriptionModuleSpec(int nt, int nc, byte type) Constructs a 'ModuleSpec' object, initializing all the components and tiles to the 'SPEC_DEF' spec val type, for the specified number of components and tiles. -
Method Summary
Modifier and TypeMethodDescriptionprotected Objectclone()getCompDef(int c) Gets default value of the specified component.getCopy()Gets default value for this module.protected ObjectgetSpec(int t, int c) Gets value of specified tile-component without knowing if a specific tile-component value has been previously entered.bytegetSpecValType(int t, int c) Return the spec type of the given tile-component.getTileCompVal(int t, int c) Gets value of specified tile-component.getTileDef(int t) Gets default value of the specified tile.booleanisCompSpecified(int c) Whether or not specifications have been entered for the given component.booleanisTileCompSpecified(int t, int c) Whether or not a tile-component specification has been definedbooleanisTileSpecified(int t) Whether or not specifications have been entered for the given tile.static final boolean[]This method is responsible of parsing tile indexes set and component indexes set for an option.voidRotate the ModuleSpec instance by 90 degrees (this modifies only tile and tile-component specifications).voidsetCompDef(int c, Object value) Sets default value for specified component and specValType tag if allowed by its priority.voidsetDefault(Object value) Sets default value for this modulevoidsetTileCompVal(int t, int c, Object value) Sets value for specified tile-component.voidsetTileDef(int t, Object value) Sets default value for specified tile and specValType tag if allowed by its priority.
-
Field Details
-
SPEC_TYPE_COMP
public static final byte SPEC_TYPE_COMPThe identifier for a specification module that applies only to components- See Also:
-
SPEC_TYPE_TILE
public static final byte SPEC_TYPE_TILEThe identifier for a specification module that applies only to tiles- See Also:
-
SPEC_TYPE_TILE_COMP
public static final byte SPEC_TYPE_TILE_COMPThe identifier for a specification module that applies both to tiles and components- See Also:
-
SPEC_DEF
public static final byte SPEC_DEFThe identifier for default specification- See Also:
-
SPEC_COMP_DEF
public static final byte SPEC_COMP_DEFThe identifier for "component default" specification- See Also:
-
SPEC_TILE_DEF
public static final byte SPEC_TILE_DEFThe identifier for "tile default" specification- See Also:
-
SPEC_TILE_COMP
public static final byte SPEC_TILE_COMPThe identifier for a "tile-component" specification- See Also:
-
specType
protected int specTypeThe type of the specification module -
nTiles
protected int nTilesThe number of tiles -
nComp
protected int nCompThe number of components -
specValType
protected byte[][] specValTypeThe spec type for each tile-component. The first index is the tile index, the second is the component index. -
def
Default value for each tile-component -
compDef
The default value for each component. Null if no component specific value is defined -
tileDef
The default value for each tile. Null if no tile specific value is defined -
tileCompVal
The specific value for each tile-component. Value of tile 16 component 3 is accessible through the hash value "t16c3". Null if no tile-component specific value is defined -
specified
The specified value in string format
-
-
Constructor Details
-
ModuleSpec
public ModuleSpec(int nt, int nc, byte type) Constructs a 'ModuleSpec' object, initializing all the components and tiles to the 'SPEC_DEF' spec val type, for the specified number of components and tiles.- Parameters:
nt- The number of tilesnc- The number of componentstype- the type of the specification module i.e. tile specific, component specific or both.
-
-
Method Details
-
getCopy
-
clone
-
rotate90
Rotate the ModuleSpec instance by 90 degrees (this modifies only tile and tile-component specifications).- Parameters:
anT- Number of tiles along horizontal and vertical axis after rotation.
-
setDefault
Sets default value for this module -
getDefault
Gets default value for this module.- Returns:
- The default value (Must be casted before use)
-
setCompDef
Sets default value for specified component and specValType tag if allowed by its priority.- Parameters:
c- Component index
-
getCompDef
Gets default value of the specified component. If no specification have been entered for this component, returns default value.- Parameters:
c- Component index- Returns:
- The default value for this component (Must be casted before use)
- See Also:
-
setTileDef
Sets default value for specified tile and specValType tag if allowed by its priority.- Parameters:
t- Tile index.
-
getTileDef
Gets default value of the specified tile. If no specification has been entered, it returns the default value.- Parameters:
t- Tile index- Returns:
- The default value for this tile (Must be casted before use)
- See Also:
-
setTileCompVal
Sets value for specified tile-component.- Parameters:
t- Tie indexc- Component index
-
getTileCompVal
Gets value of specified tile-component. This method calls getSpec but has a public access.- Parameters:
t- Tile indexc- Component index- Returns:
- The value of this tile-component (Must be casted before use)
- See Also:
-
getSpec
Gets value of specified tile-component without knowing if a specific tile-component value has been previously entered. It first check if a tile-component specific value has been entered, then if a tile specific value exist, then if a component specific value exist. If not the default value is returned.- Parameters:
t- Tile indexc- Component index- Returns:
- Value for this tile component.
-
getSpecValType
public byte getSpecValType(int t, int c) Return the spec type of the given tile-component.- Parameters:
t- Tile indexc- Component index
-
isCompSpecified
public boolean isCompSpecified(int c) Whether or not specifications have been entered for the given component.- Parameters:
c- Index of the component- Returns:
- True if component specification has been defined
-
isTileSpecified
public boolean isTileSpecified(int t) Whether or not specifications have been entered for the given tile.- Parameters:
t- Index of the tile- Returns:
- True if tile specification has been entered
-
isTileCompSpecified
public boolean isTileCompSpecified(int t, int c) Whether or not a tile-component specification has been defined- Parameters:
t- Tile indexc- Component index- Returns:
- True if a tile-component specification has been defined.
-
parseIdx
This method is responsible of parsing tile indexes set and component indexes set for an option. Such an argument must follow the following policy:
t\<indexes set\> or c\<indexes set\> where tile or component indexes are separated by commas or a dashes.Example:
- t0,3,4 means tiles with indexes 0, 3 and 4.
- t2-4 means tiles with indexes 2,3 and 4.
It returns a boolean array skteching which tile or component are concerned by the next parameters.- Parameters:
word- The word to parse.maxIdx- Maximum authorized index- Returns:
- Indexes concerned by this parameter.
- t0,3,4 means tiles with indexes 0, 3 and 4.
-